Declare aboutcode.pipeline as an external dependencies #1423

Signed-off-by: tdruez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -1,7 +1,7 @@
 Changelog
 =========
 
-v34.9.5 (unreleased)
+v34.9.5 (2025-02-19)
 --------------------
 
 - Add support for the XLSX report in REST API.
@@ -11,6 +11,10 @@ v34.9.5 (unreleased)
   Also, the Project labels are kept during reset.
   https://github.com/aboutcode-org/scancode.io/issues/1568
 
+- Add aboutcode.pipeline as an install_requires external dependency to prevent conflicts
+  with other aboutcode submodules.
+  https://github.com/aboutcode-org/scancode.io/issues/1423
+
 v34.9.4 (2025-01-21)
 --------------------
 

RELEASE.md

@@ -0,0 +1,31 @@
+# Release instructions for `ScanCode.io`
+
+### Automated release workflow
+
+- Create a new `release-x.x.x` branch
+- Update the version in:
+  - `setup.cfg` (2 entries)
+  - `scancodeio/__init__.py`
+  - `CHANGELOG.rst` (set date)
+- Commit and push this branch
+- Create a PR and merge once approved
+- Tag and push that tag. This will triggers the `pypi-release.yml` GitHub workflow that 
+  takes care of building the dist release files and upload those to pypi:
+  ```
+  VERSION=vx.x.x  # <- Set the new version here
+  git tag -a $VERSION -m ""
+  git push origin $VERSION
+  ```
+- Review the GitHub release created by the workflow at 
+  https://github.com/aboutcode-org/scancode.io/releases
+
+### Manual build
+
+```
+cd scancode.io
+source .venv/bin/activate
+pip install build
+python -m build --sdist --wheel --outdir dist/ .
+```
+
+The distribution files will be available in the local `dist/` directory.

scancodeio/__init__.py

@@ -28,7 +28,7 @@
 
 import git
 
-VERSION = "34.9.4"
+VERSION = "34.9.5"
 
 PROJECT_DIR = Path(__file__).resolve().parent
 ROOT_DIR = PROJECT_DIR.parent

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = scancodeio
-version = 34.9.4
+version = 34.9.5
 license = Apache-2.0
 description = Automate software composition analysis pipelines
 long_description = file:README.rst
@@ -45,7 +45,7 @@ license_files =
 
 [options]
 python_requires = >=3.10
-packages=find:
+packages = find:
 include_package_data = true
 zip_safe = false
 install_requires =
@@ -109,6 +109,8 @@ install_requires =
     clamd==1.0.2
     # FederatedCode
     aboutcode.hashid==0.2.0
+    # AboutCode pipeline
+    aboutcode.pipeline==0.2.0
 
 [options.extras_require]
 dev =
@@ -158,7 +160,7 @@ scancodeio_pipelines =
 
 [bumpver]
 version_pattern = "MAJOR.MINOR.PATCH"
-current_version = "34.9.4"
+current_version = "34.9.5"
 
 [bumpver:file_patterns]
 setup.cfg =