Refine workflow and add documentation and changelog #1351

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

Author: tdruez

Diff for: .github/workflows/pypi-release-aboutcode-pipeline.yml

@@ -2,9 +2,9 @@ name: Build aboutcode.pipeline Python distributions and publish on PyPI
 
 on:
   workflow_dispatch:
-  # push:
-  #   tags:
-  #     - "aboutcode.pipeline/v*.*.*"
+  push:
+   tags:
+     - "aboutcode.pipeline/*"
 
 jobs:
   build-and-publish:
@@ -36,9 +36,3 @@ jobs:
         with:
           name: pypi_archives
           path: dist/*
-
-      - name: Create a GitHub release
-        uses: softprops/action-gh-release@v1
-        with:
-          draft: false
-          files: dist/*

Diff for: aboutcode/pipeline/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Release 0.1.0 (August 9, 2023)
+
+* Initial release of the `aboutcode.pipeline` library. [Issue #1351](https://github.com/nexB/scancode.io/issues/1351)

Diff for: aboutcode/pipeline/RELEASE.md

@@ -0,0 +1,29 @@
+# Release instructions for `aboutcode.pipeline`
+
+### Automated release workflow
+
+- Create a new `aboutcode.pipeline-release-x.x.x` branch
+- Update the version in:
+  - `pipeline-pyproject.toml`
+  - `aboutcode/pipeline/__init__.py`
+- Commit and push this branch
+- Create a PR and merge once approved
+- Tag and push to trigger the `pypi-release-aboutcode-pipeline.yml` workflow that 
+  takes care of building the distribution archives and upload those to pypi::
+  ```
+  VERSION=x.x.x  # <- Set the new version here
+  TAG=aboutcode.pipeline/$VERSION
+  git tag -a $TAG -m ""
+  git push origin $TAG
+  ```
+
+### Manual build
+
+```
+cd scancode.io
+source .venv/bin/activate
+pip install flot
+flot --pyproject pipeline-pyproject.toml --sdist --wheel --output-dir dist/
+```
+
+The distribution archives will be available in the local `dist/` directory.

Diff for: aboutcode/pipeline/__init__.py

@@ -30,7 +30,7 @@
 
 module_logger = logging.getLogger(__name__)
 
-__version__ = "0.1"
+__version__ = "0.1.0"
 
 
 class PipelineDefinition:

Diff for: pipeline-pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flot.buildapi"
 
 [project]
 name = "aboutcode.pipeline"
-version = "0.1"
+version = "0.1.0"
 description = "AboutCode Pipeline library. Execute code in steps."
 license = { text = "Apache-2.0" }
 readme = "aboutcode/pipeline/README.md"
@@ -31,6 +31,7 @@ classifiers = [
 [project.urls]
 Homepage = "https://github.com/nexB/scancode.io"
 Documentation = "https://scancodeio.readthedocs.io/"
+Changelog = "https://github.com/nexB/scancode.io/tree/main/aboutcode/pipeline/CHANGELOG.md"
 Repository = "https://github.com/nexB/scancode.io/tree/main/aboutcode/pipeline"
 Issues = "https://github.com/nexB/scancode.io/issues"