-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change: Update documentation for actions
Update and improve README for documenting the actions.
- Loading branch information
1 parent
568f346
commit a907c74
Showing
18 changed files
with
437 additions
and
144 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,40 @@ | ||
| # Admin bypass Action | ||
|
|
||
| GitHub Action that allows or disallows repository admins to bypass branch | ||
| protection rules. | ||
|
|
||
| ## Examples | ||
|
|
||
| ```yml | ||
| name: Bypass Branch Protection | ||
|
|
||
| on: | ||
| push: | ||
|
|
||
| jobs: | ||
| lock: | ||
| name: Bypass Protection | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: allow admin users bypassing protection on <target> branch on <repository> | ||
| uses: greenbone/actions/admin-bypass@v2 | ||
| with: | ||
| allow: "true" | ||
| branch: <target> | ||
| repository: <repository> | ||
| - name: disable bypassing protection on <target> branch on <repository> for admin users | ||
| uses: greenbone/actions/admin-bypass@v2 | ||
| with: | ||
| allow: "false" | ||
| branch: <target> | ||
| repository: <repository> | ||
| ``` | ||
| ## Action Configuration | ||
| |Input Variable|Description| | | ||
| |--------------|-----------|-| | ||
| | github-token | Github user token, that is legitimated to bypass branch protection. | Optional (default: `${{ github.token }}`) | | ||
| | allow | Allow or not? (Options: `"true"`, `"false"`)? | Optional (default is `"false"`) | | ||
| | repository | What repository branch should be able to be bypassed by admins? Defaults to the executing repository. | Optional (default is `${{ github.repository }}` | | ||
| | branch | Target branch for the bypass. | Optional (default is `"main"`) | |
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,27 @@ | ||
| # Check Version | ||
|
|
||
| GitHub Action to check version information of a project via pontos | ||
|
|
||
| ## Example | ||
|
|
||
| ```yml | ||
| name: Check Versioning | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| check: | ||
| name: Check Versioning | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: greenbone/actions/check-version@v2 | ||
| ``` | ||
| ## Action Configuration | ||
| |Input Variable|Description| | | ||
| |--------------|-----------|-| | ||
| | python-version | Python version to use for running the action. | Optional (default is `3.10`) | | ||
| | working-directory | "A working directory where to check the versioning | Optional (default is `${{ github.workspace }}`) | |
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,36 @@ | ||
| # Python Coverage Report | ||
|
|
||
| Action to setup Python, poetry, the project itself and afterwards to create a | ||
| test coverage report. | ||
|
|
||
| ## Example | ||
|
|
||
| ```yaml | ||
| name: Code Coverage | ||
|
|
||
| on: | ||
| release: | ||
| types: [created] | ||
|
|
||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Create Coverage Report | ||
| uses: greenbone/actions/coverage-python@v2 | ||
| ``` | ||
| ## Action Configuration | ||
| | Input | Description | | | ||
| |-------|-------------|-| | ||
| | python-version | Python version that should be installed | Optional (default: "3.10") | | ||
| | test-command | Command to run the unit tests | Optional (default: `"-m unittest"`) | ||
| | poetry-version | Use a specific poetry version. By default the latest release is used. | Optional | | ||
| | cache | Cache dependencies by setting it to `"true"`. Leave unset or set to an other string then `"true"` to disable the cache. | Optional | | ||
| | cache-dependency-path | "Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies. | Optional | | ||
| | cache-poetry-installation | Cache poetry and its dependencies. Default is `"true"`. Set to an other string then `"true"` to disable the cache. | Optional (default is `"true"`) | | ||
| | install-dependencies | Install project dependencies. Default is `"true"`. Set to an other string then `"true"` to not install the dependencies. | Optional (default: `"true"`) | | ||
| | working-directory | Working directory where to run the action | Optional (default is `${{ github.workspace }}`) | | ||
| | codecov-upload | "Upload coverage to codecov.io. Default is `"true"`. Set to an other string then `"true"` to disable the upload. | Optional (default: `"true"`) | ||
| | token | Upload token for codecov.io. | Required only if codecov-upload is `"true"` | |
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,35 @@ | ||
| # Lint Python Action | ||
|
|
||
| GitHub Action to setup a Python project and lint it via pylint | ||
|
|
||
| ## Example | ||
|
|
||
| ```yml | ||
| name: Linting | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| lint-python: | ||
| name: Setup Python and lint project | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: greenbone/actions/lint-python@v2 | ||
| with: | ||
| packages: my_project tests | ||
| ``` | ||
| ## Action Configuration | ||
| |Input Variable|Description| | | ||
| |--------------|-----------|-| | ||
| | packages | Python packages to lint | Required | | ||
| | python-version | Python version to use for running the action. | Optional (default is `3.10`) | | ||
| | poetry-version | Use a specific poetry version. By default the latest release is used. | Optional (default latest poetry version) | | ||
| | cache | Cache dependencies by setting it to `"true"`. Leave unset or set to an other string then `"true"` to disable the cache. | Optional | | ||
| | cache-dependency-path | Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies. | Optional | | ||
| | cache-poetry-installation | "Cache poetry and its dependencies. Default is `"true"`. Set to an other string then `"true"` to disable the cache." | Optional (default: `"true"`) | | ||
| | install-dependencies | Install project dependencies. Default is `"true"`. Set to an other string then `"true"` to not install the dependencies. | Optional (default: `"true"`) | ||
| | working-directory | Working directory where to run the action | Optional (default is `${{ github.workspace }}`) | | ||
|
|
Oops, something went wrong.