Merge branch 'main' into 1145-load-spdx-dependencies

Author: tdruez

.github/workflows/publish-docker.yml renamed to .github/workflows/publish-docker-image.yml

@@ -1,4 +1,4 @@
-name: Publish Docker image on GHCR
+name: Publish Docker image on GitHub Container Registry
 # https://docs.github.com/en/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions
 
 on:
@@ -15,8 +15,8 @@ env:
   IMAGE_NAME: ${{ github.repository }}
 
 jobs:
-  build-and-push-image:
-    runs-on: ubuntu-22.04
+  build-and-publish-image:
+    runs-on: ubuntu-24.04
 
     # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
     permissions:

.github/workflows/pypi-release-aboutcode-pipeline.yml renamed to .github/workflows/publish-pypi-release-aboutcode-pipeline.yml

@@ -3,13 +3,13 @@ name: Build aboutcode.pipeline Python distributions and publish on PyPI
 on:
   workflow_dispatch:
   push:
-   tags:
-     - "aboutcode.pipeline/*"
+    tags:
+      - "aboutcode.pipeline/*"
 
 jobs:
   build-and-publish:
     name: Build and publish library to PyPI
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/pypi-release.yml renamed to .github/workflows/publish-pypi-release.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   build-and-publish:
     name: Build and publish library to PyPI
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/ci-docker.yml renamed to .github/workflows/run-unit-tests-docker.yml

@@ -1,10 +1,18 @@
-name: Test on Docker CI
+name: Run unit tests on Docker container
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
 
 jobs:
-  build:
-    runs-on: ubuntu-22.04
+  run-unit-tests:
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Checkout code

.github/workflows/run-unit-tests-macos.yml

@@ -0,0 +1,53 @@
+name: Run unit tests on macOS
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+env:
+  POSTGRES_DB: scancodeio
+  POSTGRES_USER: scancodeio
+  POSTGRES_PASSWORD: scancodeio
+
+jobs:
+  run-unit-tests:
+    runs-on: macos-13
+
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: ikalnytskyi/action-setup-postgres@v7
+        id: postgres
+        with:
+          postgres-version: "14"  # 13 is not supported.
+          database: ${{ env.POSTGRES_DB }}
+          username: ${{ env.POSTGRES_USER }}
+          password: ${{ env.POSTGRES_PASSWORD }}
+          port: 5432
+
+      - name: Install Python dependencies
+        run: make dev envfile
+
+      - name: Run Django tests
+        run: .venv/bin/python manage.py test --verbosity=2 --noinput
+        env:
+          SCANCODEIO_DB_NAME: ${{ env.POSTGRES_DB }}
+          SCANCODEIO_DB_USER: ${{ env.POSTGRES_USER }}
+          SCANCODEIO_DB_PASSWORD: ${{ env.POSTGRES_PASSWORD }}

.github/workflows/ci.yml renamed to .github/workflows/run-unit-tests.yml

@@ -1,6 +1,14 @@
-name: Test CI
+name: Run unit tests
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
 
 env:
   POSTGRES_DB: scancodeio
@@ -9,8 +17,8 @@ env:
   POSTGRES_INITDB_ARGS: --encoding=UTF-8 --lc-collate=en_US.UTF-8 --lc-ctype=en_US.UTF-8
 
 jobs:
-  build:
-    runs-on: ubuntu-22.04
+  run-unit-tests:
+    runs-on: ubuntu-24.04
 
     services:
       postgres:

CHANGELOG.rst

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+v35.2.0 (unreleased)
+--------------------
+
+- Refactor policies implementation to support more than licenses.
+  The entire ``policies`` data is now stored on the ``ScanPipeConfig`` in place of the
+  ``license_policy_index``.
+  Also, a new method ``get_policies_dict`` methods is now available on the ``Project``
+  model to easily retrieve all the policies data as a dictionary.
+  Renamed for clarity:
+  * ``policy_index`` to ``license_policy_index``
+  * ``policies_enabled`` to ``license_policies_enabled``
+  https://github.com/aboutcode-org/scancode.io/pull/1718
+
+- Add support for SPDX license identifiers as ``license_key`` in license policies
+  ``policies.yml`` file.
+  https://github.com/aboutcode-org/scancode.io/issues/1348
+
 v35.1.0 (2025-07-02)
 --------------------
 

docs/faq.rst

@@ -24,11 +24,16 @@ you may use the Docker image to run pipelines as a single command:
   docker run --rm \
     -v "$(pwd)":/codedrop \
     ghcr.io/aboutcode-org/scancode.io:latest \
-    sh -c "run scan_codebase /codedrop" \
+    run scan_codebase /codedrop \
     > results.json
 
 Refer to the :ref:`cli_run` section for more about this approach.
 
+.. tip::
+    Prefer a one-liner? Use this to scan your current directory::
+
+        curl -sSL https://raw.githubusercontent.com/aboutcode-org/scancode.io/main/etc/scripts/run-scan.sh | bash
+
 .. _faq_which_pipeline:
 
 Which pipeline should I use?

docs/index.rst

@@ -1,19 +1,22 @@
-ScanCode.io documentation
+ScanCode.io Documentation
 =========================
 
-Welcome to the very start of your ScanCode.io journey! In this documentation
-you’ll find information on:
+Welcome! This is your starting point for everything ScanCode.io.
 
-- An overview of ScanCode.io and ScanPipe
-- Installation instructions
-- Tutorials to get you started
-- Reference documentation about the ScanPipe concepts, Pipelines, Pipes and more
-- How to make technical contributions to the project and the community
+In this documentation, you’ll find:
+
+- A **QuickStart guide** to run your first scan
+- An **overview** of what ScanCode.io is and what it can do
+- **Installation instructions** for full access
+- Step-by-step **tutorials** to dive deeper
+- In-depth **reference docs** on concepts, pipelines, configuration, and APIs
+- Guides on how to **contribute** to the project and community
 
 .. toctree::
     :maxdepth: 2
     :caption: Getting Started
 
+    quickstart
     introduction
     installation
     user-interface
@@ -23,7 +26,7 @@ you’ll find information on:
 
 .. toctree::
     :maxdepth: 2
-    :caption: Tutorial
+    :caption: Tutorials
 
     tutorial_web_ui_analyze_docker_image
     tutorial_web_ui_review_scan_results
@@ -37,7 +40,7 @@ you’ll find information on:
 
 .. toctree::
     :maxdepth: 2
-    :caption: Reference Documentation
+    :caption: Reference
 
     scanpipe-concepts
     built-in-pipelines

docs/installation.rst

@@ -221,8 +221,8 @@ And visit the web UI at: http://localhost/project/
 
 .. _local_development_installation:
 
-Local development installation
-------------------------------
+Local development
+-----------------
 
 Supported Platforms
 ^^^^^^^^^^^^^^^^^^^
@@ -247,7 +247,7 @@ Before you install ScanCode.io, make sure you have the following prerequisites:
 
  * **Python: versions 3.10 to 3.13** found at https://www.python.org/downloads/
  * **Git**: most recent release available at https://git-scm.com/
- * **PostgreSQL**: release 11 or later found at https://www.postgresql.org/ or
+ * **PostgreSQL**: release 13 or later found at https://www.postgresql.org/ or
    https://postgresapp.com/ on macOS
 
 .. _system_dependencies: