Skip to content

Commit 773fa88

Browse files
committed
Refine the "Integrate with Your Workflows" docs section
Signed-off-by: tdruez <[email protected]>
1 parent ec7dfcc commit 773fa88

File tree

2 files changed

+25
-14
lines changed

2 files changed

+25
-14
lines changed

docs/automation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ Integrate ScanCode.io into your Jenkins pipelines with a simple Jenkinsfile.
7575
**Full documentation:**
7676
https://github.com/aboutcode-org/scancode-action/blob/main/jenkins/README.md
7777

78-
GitLab CI/CD
79-
^^^^^^^^^^^^
78+
GitLab
79+
^^^^^^
8080

8181
Run ScanCode.io scans in your GitLab pipelines.
8282

docs/quickstart.rst

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -183,22 +183,31 @@ See the :ref:`installation` chapter for the full list of installation options.
183183
Integrate with Your Workflows
184184
-----------------------------
185185

186-
ScanCode.io can be part of your CI/CD workflow.
186+
ScanCode.io integrates seamlessly into CI/CD pipelines, enabling automated scans on
187+
commits, pull requests, releases, and scheduled events.
188+
189+
**Supported platforms:**
190+
191+
- **GitHub Actions** - Official action with built-in compliance checks
192+
- **GitLab** - Docker-based pipeline integration
193+
- **Jenkins** - Jenkinsfile integration with artifact archiving
194+
- **Azure Pipelines** - Azure DevOps pipeline support
195+
- **Any CI/CD system** - Direct Docker command integration
187196

188197
GitHub Actions
189198
^^^^^^^^^^^^^^
190199

191200
Use the official `scancode-action <https://github.com/aboutcode-org/scancode-action>`_
192-
to integrate **ScanCode.io into your GitHub workflows** with ease.
201+
to integrate ScanCode.io into your GitHub workflows.
193202

194-
This action lets you:
203+
**Features:**
195204

196-
- **Run pipelines**
197-
- **Check for compliance issues**
198-
- **Detect vulnerabilities**
199-
- **Generate SBOMs and scan results**
205+
- Run pipelines automatically on repository events
206+
- Check for compliance issues and policy violations
207+
- Detect security vulnerabilities
208+
- Generate SBOMs in multiple formats (SPDX, CycloneDX)
200209

201-
Example usage:
210+
**Example usage:**
202211

203212
.. code-block:: yaml
204213
@@ -212,8 +221,10 @@ Example usage:
212221
pipelines: "scan_codebase"
213222
output-formats: "json xlsx spdx cyclonedx"
214223
215-
Full details available at:
216-
https://github.com/aboutcode-org/scancode-action
224+
**Learn more:** https://github.com/aboutcode-org/scancode-action
217225

218-
.. tip::
219-
Learn more about automation options in the :ref:`automation` section.
226+
Other CI/CD Platforms
227+
^^^^^^^^^^^^^^^^^^^^^
228+
229+
For setup instructions and examples for other platforms, see the :ref:`automation`
230+
section.

0 commit comments

Comments
 (0)