(Kept from previous group [paf22])
Summary: This page explains the GitHub lint action we use to unsure Code quality.
Tim Dreier
25.11.2022
We use a github action to verify code quality.
These actions are defined in .github/workflows/linter.yml.
The actions are executed only on pull requests in order not to exceed the minutes per month included in the Github free plan. This is done by limiting the execution of the action by the following line:
on: pull_requestThe actions uses the same linters described in the section Linting.
Event though the linters are already executed during commit, the execution on pull request ensures that nobody skips the linter during commit.
The action must pass successful to merge a pull request. To enforce this behaviour, we set the action as requirement as described in the following:
You can add rules to your branches and how your merge request works.
Your repo -> Settings -> branches -> Branch protection rules -> Add rule
There, you will find something called Require status checks to pass before merging. Under this, you should see Status checks found in the last week for this repository. If you find the status you want to be passed before merging, you can enable the same.
More information about creating and merging pull requests can be found here.
If there are errors in any file which need to be fixed, the output of the action will look similar to this:
If there are errors in any python file, the output of the action will look similar to this:
This step even runs if the markdown linter has already failed. This way, all errors of different steps are directly visible instead of errors only becoming apparent after errors in the previous steps have been fixed.