-
Notifications
You must be signed in to change notification settings - Fork 9
Open
Description
Summary
To streamline our development process and maintain high code quality, we need to integrate GitHub Actions into our workflow. This will automate code validation, formatting checks, and ensure that the build process is completed without errors.
Key Goals
- Add a GitHub Action that runs on every push and pull request to the main branch.
- The GitHub Action should:
- Install dependencies using
npm install. - Validate the codebase by running lint checks and type checks.
- Ensure the code adheres to our style guide using Prettier.
- Attempt a production build with
npm run buildto verify that the application builds correctly.
- Install dependencies using
- The workflow should fail if any of these steps do not complete successfully, blocking the merge until issues are resolved.
Implementation Checklist
- Create a
.github/workflows/ci.ymlfile with the defined steps. - Configure the workflow to run the
npm installcommand. - Add steps to run code validation (linting and type-checking).
- Include a step to check and enforce code formatting with Prettier.
- Set up the workflow to run
npm run buildand confirm it completes successfully. - Document the new process in the
README.mdto inform all contributors.
Additional Notes
This addition is crucial for preventing merge conflicts and ensuring that only thoroughly checked code is merged into the main codebase. It will also save time during code reviews as formatting and basic checks will be automated.
Feel free to discuss any further parameters or configurations that might be beneficial for this workflow.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels