-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added docs workflows and CQ improvements
* Updated script for also clearing Journal Logs * Added docker stacks * Automated documentation and secret scanning (#6) * Improved code quality and docs auto-workflow (#7) * Improved CQ and docs workflow * Fix for SH-2059, SH-2005, SH-2027, SH-1083 and more
- Loading branch information
Showing
32 changed files
with
759 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| name: Check and generate documentations | ||
|
|
||
| on: | ||
| push: | ||
|
|
||
| jobs: | ||
| check: | ||
| name: Check if generating is necessary | ||
| outputs: | ||
| run_job: ${{ steps.check_files.outputs.run_job }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 3 | ||
|
|
||
| - name: Check modified files | ||
| id: check_files | ||
| run: | | ||
| echo "=============== List modified files ===============" | ||
| git diff --name-only HEAD^ HEAD | ||
| echo "========== Check paths of modified files ==========" | ||
| git diff --name-only HEAD^ HEAD > files.txt | ||
| while IFS= read -r file | ||
| do | ||
| echo $file | ||
| if [[ $file != docs/* ]]; then | ||
| echo "This modified file is not under the 'docs' folder." | ||
| echo "::set-output name=run_job::false" | ||
| break | ||
| else | ||
| echo "::set-output name=run_job::true" | ||
| fi | ||
| done < files.txt | ||
| update: | ||
| name: Update documentation | ||
| runs-on: ubuntu-latest | ||
| needs: check | ||
| if: needs.check.outputs.run_job == 'true' | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token. | ||
| fetch-depth: 1 # otherwise, there would be errors pushing refs to the destination repository. | ||
| - uses: actions/setup-python@v3 | ||
| with: | ||
| python-version: "3.9" | ||
| cache: "pip" | ||
| - name: Updating scripts table in README.md | ||
| run: | | ||
| cd "docs/templates/" && pip install -r requirements.txt && python update_scripts_table.py | ||
| - name: Commit files | ||
| run: | | ||
| git config --local user.email "[email protected]" | ||
| git config --local user.name "Krishna Alagiri [bot]" | ||
| git commit -m "[skip ci] Updating documentation" -a | ||
| - name: Push changes | ||
| uses: ad-m/github-push-action@master | ||
| with: | ||
| github_token: ${{ secrets.GH_TOKEN }} | ||
| branch: ${{ github.ref }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: Generate Documentations | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| update: | ||
| name: Update documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token. | ||
| fetch-depth: 1 # otherwise, there would be errors pushing refs to the destination repository. | ||
| - uses: actions/setup-python@v3 | ||
| with: | ||
| python-version: "3.9" | ||
| cache: "pip" | ||
| - name: Updating scripts table in README.md | ||
| run: | | ||
| cd "docs/templates/" && pip install -r requirements.txt && python update_scripts_table.py | ||
| - name: Commit files | ||
| run: | | ||
| git config --local user.email "[email protected]" | ||
| git config --local user.name "Krishna Alagiri [bot]" | ||
| git commit -m "[skip ci] Updating documentation" -a | ||
| - name: Push changes | ||
| uses: ad-m/github-push-action@master | ||
| with: | ||
| github_token: ${{ secrets.GH_TOKEN }} | ||
| branch: ${{ github.ref }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: Scan for leaked secrets (keys, tokens, etc.) | ||
|
|
||
| on: [push, pull_request] | ||
|
|
||
| jobs: | ||
| scanning: | ||
| name: GitGuardian scan | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 # fetch all history so multiple commits can be scanned | ||
| - name: GitGuardian scan | ||
| uses: GitGuardian/ggshield-action@master | ||
| env: | ||
| GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }} | ||
| GITHUB_PUSH_BASE_SHA: ${{ github.event.base }} | ||
| GITHUB_PULL_BASE_SHA: ${{ github.event.pull_request.base.sha }} | ||
| GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} | ||
| GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -132,4 +132,5 @@ dmypy.json | |
| .vscode/ | ||
|
|
||
| # Enviroinment variable file | ||
| .env | ||
| .env | ||
| docs/~$scripts.xlsx | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.