diff --git a/docs/integrations.md b/docs/integrations.md index c34b426950f..7e4475a252a 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -8,6 +8,7 @@ We provide plugins for some CI/CD tools. For some others we provide a tutorial o Integrate KICS with: - [Azure Pipelines](integrations_azurepipelines.md) +- [Bamboo](integrations_bamboo.md) - [Bitbucket Pipelines](integrations_bitbucketpipelines.md) - [CircleCI](integrations_circleci.md) - [Github Actions](integrations_ghactions.md) diff --git a/docs/integrations_bamboo.md b/docs/integrations_bamboo.md new file mode 100644 index 00000000000..f033f5087a6 --- /dev/null +++ b/docs/integrations_bamboo.md @@ -0,0 +1,23 @@ +# Running KICS in Bamboo + +You can easily integrate KICS into Bamboo. The example below demonstrates how you can run KICS in a build plan linked to a GitHub repository. + + +After you create a project with a build plan linked to a Github repository, you need to create a task to run KICS. +The script body should contain `docker run -v ${PWD}:/path checkmarx/kics:latest scan -p /path -o /path/results --ci --ignore-on-exit results`. + + +![creatingTask](https://user-images.githubusercontent.com/74001161/152352791-9aa161b9-5d57-456b-a0a8-990930bf7960.gif) + + +For example, to turn on this task every time a commit is merged in the Github repository, you need to create a plan branch that enables that. + + + +![createPlanBranch](https://user-images.githubusercontent.com/74001161/152361840-94768245-0bbe-43cd-adaa-9afb9289e381.gif) + + +The build will run every time a commit is merged in the Github repository. + + +![commits](https://user-images.githubusercontent.com/74001161/152364388-fa37aede-a299-47bf-a3d1-45985614481c.gif) diff --git a/mkdocs.yml b/mkdocs.yml index 627129da7fc..4cd781f7f58 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,7 @@ nav: - Integrations: - Overview: integrations.md - Azure DevOps: integrations_azurepipelines.md + - Bamboo: integrations_bamboo.md - Bitbucket Pipelines: integrations_bitbucketpipelines.md - CircleCI: integrations_circleci.md - Github Actions: integrations_ghactions.md