If you submit a Pull Request to this project, a few checks will be run on it with Continuous Integration. Luckily, you can (as in, really should) also run the checks locally to avoid surprises.
TO-DO: - Describe more about the ci pipelines in this project. Teststep, Deploystep. - Add fancy pictures
Run the code quality tooling check locally with the code-quality check script:
$ ./development/code_quality.shThe script is dependent on podman.
The resulting output should be pretty self explanatory.
Tool: megalinter (various linter tools)
Currently, the following checks are enabled:
-
Markdown lint
-
Yaml lint
-
GitHub action lint
-
Repository secrets with GitLeaks and Credentials scan
-
Prettier formatting
Tool: reuse (license compliance check)
A license compliance check is run and controls that every file has valid copyright (in the SPDX-standard format).
Tool: conform (commit check)
The projects commit guides like standards if any are checked. (see CONTRIBUTING.adoc)
You will get a summary report at the end of the script run, telling you if something failed, or quality check passed.
If the locally run script shows failing checks:
You should be able to see the errors by scrolling through the output in your terminal. Fix the errors, git add the fixes to your pr and re-run the script. Hopefully it shows all green the next round.
If the CI Pipeline shows failing checks:
You can repeat the errors found by the CI by running the code quality-script locally. Fix the errors locally, and update the Pull Request when the local tests have passed. The CI-tests should now show that you passed.