Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build(cli): Add lint workflow for API #44

Merged
merged 2 commits into from
Dec 29, 2023
Merged

build(cli): Add lint workflow for API #44

merged 2 commits into from
Dec 29, 2023

Conversation

HarshPatel5940
Copy link
Contributor

@HarshPatel5940 HarshPatel5940 commented Dec 29, 2023

Type

enhancement


Description

  • Added a new GitHub Actions workflow in .github/workflows/api.yaml that triggers on push and pull request events.
  • The workflow is designed to validate the code in the apps/api directory using ESLint.
  • The workflow runs on an Ubuntu-latest environment and uses Node.js version 20 and pnpm version 8 for package management.
  • The workflow steps include checking out the code, setting up Node.js and pnpm, installing packages, and running the linting command.

PR changes walkthrough

Relevant files                                                                                                                                 
Configuration changes
1 files
api.yaml                                                                                                       
    .github/workflows/api.yaml

    The file .github/workflows/api.yaml has been added. It
    includes a new GitHub Actions workflow that triggers on push
    and pull request events. The workflow validates the code in
    the apps/api directory using ESLint. It runs on an
    Ubuntu-latest environment and uses Node.js version 20 and
    pnpm version 8 for package management. The workflow steps
    include checking out the code, setting up Node.js and pnpm,
    installing packages, and running the linting command.

+33/-0

User description

Description

This pull request adds a lint workflow to the project. The workflow runs on push and pull request events and validates the code using ESLint.

Fixes #38

Dependencies

No New Dependencies added.

uses: eslint dependency

Future Improvements

We can bump of the dependencies of the for the eslint package. All of them are non breaking updates
image

Mentions

@rajdip-b

Developer's checklist

  • My PR follows the style guidelines of this project
  • I have performed a self-check on my work
  • I have followed the coding guidelines
  • My changes in code generate no new warnings
  • I have added relevant screenshots in my PR

Copy link
Contributor

PR Description updated to latest commit (a8d6008)

@codiumai-pr-agent-free codiumai-pr-agent-free bot added the type: enhancement New feature or request label Dec 29, 2023
Copy link
Contributor

PR Analysis

  • 🎯 Main theme: Adding a new GitHub Actions workflow for linting API code
  • 📝 PR summary: This PR introduces a new GitHub Actions workflow that triggers on push and pull request events to validate the code in the apps/api directory using ESLint. The workflow runs on an Ubuntu-latest environment and uses Node.js version 20 and pnpm version 8 for package management.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 2, because the PR is straightforward and involves the addition of a new GitHub Actions workflow file.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the addition of the linting workflow will help maintain code quality in the apps/api directory. However, it would be beneficial to add a step in the workflow to cache the dependencies installed by pnpm to speed up the workflow run time.

🤖 Code feedback:
relevant file.github/workflows/api.yaml
suggestion      

Consider adding a step to cache the dependencies installed by pnpm. This can significantly speed up the workflow run time. You can use the actions/cache action for this purpose. [important]

relevant line- name: Install packages

✨ Usage tips:

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To edit any configuration parameter from the configuration.toml, add --config_path=new_value.
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, add a /config comment.

Copy link
Member

@rajdip-b rajdip-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work man! Would just need you to add this step and we are good to go!
image

@HarshPatel5940
Copy link
Contributor Author

  • string for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To edit any configuration parameter from the configuration.toml, add --config_path=new_value.
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, add a /config comment.

Noted.

Copy link
Member

@rajdip-b rajdip-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This gets merged now.

@rajdip-b rajdip-b merged commit bd299c3 into keyshade-xyz:main Dec 29, 2023
1 check failed
@rajdip-b
Copy link
Member

rajdip-b commented Feb 2, 2024

🎉 This PR is included in version 1.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@rajdip-b
Copy link
Member

rajdip-b commented Feb 9, 2024

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create lint workflow for API
2 participants