docs(integrations): add CircleCI integration example

Signed-off-by: Rogério Peixoto <[email protected]>
Checkmarx · May 4, 2021 · 83f6bae · 83f6bae
1 parent 51f283a
commit 83f6bae
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 1 deletion.
diff --git a/docs/img/circleci-artifacts.png b/docs/img/circleci-artifacts.png
diff --git a/docs/img/circleci-build.png b/docs/img/circleci-build.png
diff --git a/docs/img/circleci-results.png b/docs/img/circleci-results.png
diff --git a/docs/integrations.md b/docs/integrations.md
@@ -7,6 +7,7 @@ Integrate KICS with:
 
 - [Azure Pipelines](integrations_azurepipelines.md)
 - [Bitbucket Pipelines](integrations_bitbucketpipelines.md)
+- [CircleCI](integrations_circleci.md)
 - [Github Actions](integrations_ghactions.md)
 - [GitLab CI](integrations_gitlabci.md)
 - [Jenkins](integrations_jenkins.md)

diff --git a/docs/integrations_circleci.md b/docs/integrations_circleci.md
@@ -0,0 +1,47 @@
+# Running KICS in CircleCI
+
+You can integrate KICS into your CircleCI workflows.
+
+This document provides you with an example on how to run KICS scans in a pipeline.
+
+## Example setup with GitHub:
+
+Enable CircleCI to access your personal profile or GitHub organization.
+
+Create a `.circleci` directory in your project's root and place a `config.yaml` inside:
+
+```yaml
+version: 2.1
+jobs:
+  kics:
+    docker:
+      - image: checkmarx/kics:latest-alpine
+    steps:
+      - checkout
+      - run:
+          name: Run KICS
+          command: |
+            /app/bin/kics scan -p ${PWD} -o ~/results.json --ci
+      - store_artifacts:
+          path: ~/results.json
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      # etc...
+      - kics
+
+```
+
+After running a pipeline you will be able to see the Run KICS step inside the workflow details:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/circleci-build.png" width="850">
+
+Go to the artifacts tab to inspect the results:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/circleci-artifacts.png" width="850">
+
+The results will be displayed in plain text:
+
+<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/circleci-results.png" width="850">
diff --git a/docs/integrations_jenkins.md b/docs/integrations_jenkins.md
@@ -2,7 +2,7 @@
 
 You can integrate KICS into your Jenkins CI/CD pipelines.
 
-This provides you the ability to run KICS scans in as a stage in your pipeline.
+This provides you the ability to run KICS scans as a stage in your pipeline.
 
 ## Declarative pipelines:
 

diff --git a/examples/circleci/config.yaml b/examples/circleci/config.yaml
@@ -0,0 +1,20 @@
+version: 2.1
+jobs:
+  kics:
+    docker:
+      - image: checkmarx/kics:latest-alpine
+    steps:
+      - checkout
+      - run:
+          name: Run KICS
+          command: |
+            /app/bin/kics scan -p ${PWD} -o ~/results.json --ci
+      - store_artifacts:
+          path: ~/results.json
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      # etc...
+      - kics