From 581ccdf1b4239e995074e16bb6501fc90b7a3222 Mon Sep 17 00:00:00 2001 From: Iliyan Vutoff Date: Mon, 13 Nov 2023 18:06:29 +0200 Subject: [PATCH] Add a task to create CONTRIBUTORS guide --- M1-4-2-CI-Practice/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/M1-4-2-CI-Practice/README.md b/M1-4-2-CI-Practice/README.md index 5f342dcb..ad8e4088 100644 --- a/M1-4-2-CI-Practice/README.md +++ b/M1-4-2-CI-Practice/README.md @@ -2,10 +2,11 @@ ## 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 @@ -13,6 +14,7 @@ Create a GitHub Actions pipeline that runs on commit to a feature branch (i.e. n - 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