Skip to content

Commit 581ccdf

Browse files
author
Iliyan Vutoff
committed
Add a task to create CONTRIBUTORS guide
1 parent 100f4c9 commit 581ccdf

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

M1-4-2-CI-Practice/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
## Task description
44

5-
Create a GitHub Actions pipeline that runs on commit to a feature branch (i.e. not `main`) and performs the following checks on our simple Flask app.
5+
Create a GitHub Actions pipeline that runs on commit to a feature branch (i.e. not `main`) and performs the following checks on our simple Flask app repository.
66

77
- Check `.editorconfig`
88
- Code Lint and style - use `pylint` and `black` to check for style/formatting/syntax errors
9+
- Check makrdown files [markdownlint-cli](https://www.npmjs.com/package/cli-markdown)
910
- Code Unittest - there's a simple unit test next to our app called `app_test.py`. Make sure our unittest passes (`python -m unittest` executed in the app directory)
1011
- Check for hardcoded secrets (`gitleaks`) - not just our app but the whole repository.
1112
- SAST - SonarCloud; Review code smells and security issues
1213
- SCA - Snyk; review security issues
1314
- Build a Docker image. Use Git commit SHA as an Image tag.
1415
- Scan the built image with `Trivy`
1516
- Push the built image to your Docker HUB account
17+
- (optional) Add CONTRIBUTORS guide. Follow [this](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) document from GitHUb.
1618

1719
:warning: Make sure that you run as many tests in parallel as you see fit
1820

0 commit comments

Comments
 (0)