Skip to content

Commit

Permalink
Add a task to create CONTRIBUTORS guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vutoff committed Nov 13, 2023
1 parent 100f4c9 commit 581ccdf
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion M1-4-2-CI-Practice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@

## Task description

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.
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.

- Check `.editorconfig`
- Code Lint and style - use `pylint` and `black` to check for style/formatting/syntax errors
- Check makrdown files [markdownlint-cli](https://www.npmjs.com/package/cli-markdown)
- 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)
- Check for hardcoded secrets (`gitleaks`) - not just our app but the whole repository.
- SAST - SonarCloud; Review code smells and security issues
- SCA - Snyk; review security issues
- Build a Docker image. Use Git commit SHA as an Image tag.
- Scan the built image with `Trivy`
- Push the built image to your Docker HUB account
- (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.

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

Expand Down

0 comments on commit 581ccdf

Please sign in to comment.