Code Quality Workflow
Prerequisites
Overview
Ensures code consistency and quality through automated linting and formatting checks.
The following sequence diagram illustrates the interactions and steps involved in the Code Quality workflow, triggered by a push to the main branch or a pull request.
Step 1 — Configure Necessary Secrets
For the Code Quality workflow to function correctly, certain secrets must be configured in your GitHub repository settings. These secrets ensure secure access to necessary tools and services during the workflow execution.
a. Navigate to Repository Settings
Go to your repository on GitHub.
Click on the Settings tab.
b. Access Secrets
In the left sidebar, click on Secrets and variables under the Security section.
Select Actions to manage secrets for GitHub Actions.
c. Add Required Secrets
GITHUB_TOKEN: This token is automatically provided by GitHub Actions and typically does not need to be added manually unless you require customized permissions.
Additional Secrets: If your workflow requires access to external services or APIs (e.g., authentication tokens, API keys), add them here by clicking on New repository secret and providing the necessary name and value.
Step 2 — Create the Code Quality Workflow File
Create a GitHub Actions workflow file that defines the steps for automated linting and formatting checks. This workflow will be triggered by pushes to the main branch or the creation/update of pull requests.
a. Add the Workflow File
In your repository, navigate to the
.github/workflows/directory. If it doesn't exist, create it.Create a new file named
code-quality.yml(or any name of your choice).
b. Define the Workflow
Add the following content to the code-quality.yml file: