Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add github-actions documentation #1172

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add github-actions documentation #1172

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec56cc0
add github-actions documentation
Killpit Sep 17, 2024
d4400ac
made suggested changes to documentation
Killpit Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions doc/source/ci-cd/github-actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
-----------------
GitHub-Actions
-----------------
Killpit marked this conversation as resolved.
Show resolved Hide resolved

Here is a minimal complete example workflow to create a Code Scanning action using Bandit by using GitHub Actions from PyCQA's `bandit-action <https://github.com/PyCQA/bandit-action>`.

-----------------
Example YAML code for GitHub Actions Pipeline
-----------------
Killpit marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: yaml

name: Bandit

on:
workflow_dispatch:

jobs:
analyze:
runs-on: ubuntu-latest
permissions:
# required for all workflows
security-events: write
# only required for workflows in private repositories
actions: read
contents: read
steps:
- name: Perform Bandit Analysis
uses: PyCQA/bandit-action@v1

-----------------
Inputs
-----------------
Killpit marked this conversation as resolved.
Show resolved Hide resolved

.. list-table::
:widths: 30 50 10 20

* Name * Description * Required * Default Value
* configfile * Config file to use for selecting plugins and overriding defaults * False * "DEFAULT"
* profile * Profile to use (defaults to executing all tests) * False * "DEFAULT"
* tests * Comma-separated list of test IDs to run * False * "DEFAULT"
* skips * Comma-separated list of test IDs to skip * False * "DEFAULT"
* severity * Report only issues of a given severity level or higher. "all" and "low" are likely to produce the same results, but it is possible for rules to be undefined which will not be listed in "low".  
Options include: (all, high, medium, low) * False * "DEFAULT"
* confidence * Report only issues of a given confidence level or higher. "all" and "low" are likely to produce the same results, but it is possible for rules to be undefined which will not be listed in "low".
Options include: {all, high, medium, low} * False * "DEFAULT"
* exclude * Comma-separated list of paths (glob patterns supported) to exclude from scan (note that these are in addition to the excluded paths provided in the config file) * False * ".svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg"
* baseline * Path of a baseline report to compare against (only JSON-formatted files are accepted) * False * "DEFAULT"
* ini * Path to a .bandit file that supplies command line arguments * False * "DEFAULT"
* targets * Source file(s) or directory(s) to be tested * False * "."
Loading