scancode-action docs #599

README.rst

@@ -19,6 +19,12 @@ please ask them in `Discussions <https://github.com/nexB/scancode.io/discussions
 If you want to contribute to ScanCode.io, start with our
 `Contributing <https://scancodeio.readthedocs.io/en/latest/contributing.html>`_ page.
 
+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
 ----------------------
 

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 <https://github.com/nexB/scancode-action>`_ 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)
 --------------------------------------------------------------------

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 <https://github.com/nexB/scancode-action>`_
+to run ScanCode.io pipelines from your GitHub Workflows.

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