From d810ac5328161eb4653443e582ddef3593f43fb4 Mon Sep 17 00:00:00 2001 From: tdruez Date: Tue, 30 Jan 2024 14:12:53 -0700 Subject: [PATCH 1/4] Add documentation about the scancode-action GitHub action #599 Signed-off-by: tdruez --- README.rst | 7 +++++++ docs/automation.rst | 16 +++++++++------- docs/faq.rst | 6 +++++- scanpipe/pipelines/inspect_packages.py | 2 +- 4 files changed, 22 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index c3465ad493..4c35f88cd0 100644 --- a/README.rst +++ b/README.rst @@ -19,6 +19,13 @@ please ask them in `Discussions `_ page. +> [!TIP] +> A new GitHub action is now available at +> [scancode-action](https://github.com/nexB/scancode-action) +> to run ScanCode.io pipelines from your GitHub Workflows. +> Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more +> about automation. + Build and tests status ---------------------- diff --git a/docs/automation.rst b/docs/automation.rst index 86b8d51256..203f2895a0 100644 --- a/docs/automation.rst +++ b/docs/automation.rst @@ -73,15 +73,17 @@ automation methods such as a cron job or a git hook:: By providing the required environment variables in this manner, you can execute the script with the appropriate configurations and credentials. -2. Integrate ScanCode.io with your CI/CD workflow -------------------------------------------------- +2. Integrating ScanCode.io with GitHub Workflows +------------------------------------------------ -Integrate ScanCode.io seamlessly into your CI/CD workflow by using a GitHub Action, -enabling automated scans as part of your development process. +Seamlessly integrate ScanCode.io into your GitHub Workflows to enable automated scans +as an integral part of your development process. -A GitHub Action for ScanCode.io is currently under development. You can track the -progress and updates on the development process by visiting the following link: -https://github.com/nexB/scancode.io/issues/599 +Visit the `scancode-action repository `_ to +explore and learn more about the GitHub Action for ScanCode.io. +The repository provides detailed information, usage instructions, +and configuration options to help you incorporate code scanning effortlessly into your +workflows. 3. Run a Local ScanCode.io app on your machine (management commands) -------------------------------------------------------------------- diff --git a/docs/faq.rst b/docs/faq.rst index 26b6e4974a..34d9ac13e8 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -138,4 +138,8 @@ Please refer to our :ref:`output_files` section for more details on the output f How can I trigger a pipeline scan from a CI/CD, such as Jenkins, TeamCity or Azure Devops? ------------------------------------------------------------------------------------------ -You can use the :ref:`rest_api` to automate your project or pipeline management. +You can refer to the :ref:`automation` to automate your projects management. + +Also, A new GitHub action is available at +`scancode-action repository `_ +to run ScanCode.io pipelines from your GitHub Workflows. diff --git a/scanpipe/pipelines/inspect_packages.py b/scanpipe/pipelines/inspect_packages.py index 6d43b41d65..f5a8568924 100644 --- a/scanpipe/pipelines/inspect_packages.py +++ b/scanpipe/pipelines/inspect_packages.py @@ -31,7 +31,7 @@ class InspectPackages(ScanCodebase): Supports resolved packages for: - Python: using nexB/python-inspector, supports requirements.txt and - setup.py manifests as input + setup.py manifests as input Supports: - BOM: SPDX document, CycloneDX BOM, AboutCode ABOUT file From f5bbf00efb7e18bf07f1faa472228314a837a46f Mon Sep 17 00:00:00 2001 From: tdruez Date: Tue, 30 Jan 2024 14:42:43 -0700 Subject: [PATCH 2/4] Change README format #599 Signed-off-by: tdruez --- README.rst => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.rst => README.md (100%) diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md From 7de6b1354aab6f9f49512118c505c893c9506556 Mon Sep 17 00:00:00 2001 From: tdruez Date: Tue, 30 Jan 2024 14:59:16 -0700 Subject: [PATCH 3/4] Use rst format #599 Signed-off-by: tdruez --- README.md => README.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) rename README.md => README.rst (89%) diff --git a/README.md b/README.rst similarity index 89% rename from README.md rename to README.rst index 4c35f88cd0..6d1d6618af 100644 --- a/README.md +++ b/README.rst @@ -19,12 +19,13 @@ please ask them in `Discussions `_ page. -> [!TIP] -> A new GitHub action is now available at -> [scancode-action](https://github.com/nexB/scancode-action) -> to run ScanCode.io pipelines from your GitHub Workflows. -> Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more -> about automation. +.. tip:: + + A new GitHub action is now available at + `scancode-action `_ + to run ScanCode.io pipelines from your GitHub Workflows. + Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more + about automation. Build and tests status ---------------------- From d74098b527f3afe075e63a4bbd5316d17be037f0 Mon Sep 17 00:00:00 2001 From: tdruez Date: Tue, 30 Jan 2024 15:00:04 -0700 Subject: [PATCH 4/4] Fix README #599 Signed-off-by: tdruez --- README.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 6d1d6618af..fed0cabaa6 100644 --- a/README.rst +++ b/README.rst @@ -19,13 +19,11 @@ please ask them in `Discussions `_ page. -.. tip:: - - A new GitHub action is now available at - `scancode-action `_ - to run ScanCode.io pipelines from your GitHub Workflows. - Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more - about automation. +A new GitHub action is now available at +`scancode-action `_ +to run ScanCode.io pipelines from your GitHub Workflows. +Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more +about automation. Build and tests status ----------------------