Merge eb1c01e into 3a6e13d

Author: brainelectronics

.github/workflows/release.yml

@@ -36,17 +36,23 @@ jobs:
           poetry run changelog-generator \
             changelog changelog.md \
             --snippets=.snippets \
-            --in-place
+            --in-place \
+            --no-internal
       - name: Parse changelog
         id: parse_changelog
         run: |
-          poetry run changelog2version --changelog_file changelog.md --print | python -c "import sys, json; print(json.load(sys.stdin)['info']['description'])" > latest_description.txt
+          poetry run changelog2version \
+            --changelog_file changelog.md \
+            --output changelog.json \
+            --print \
+            --debug
+          echo "CHANGELOG_JSON=$(jq -c . < changelog.json)" >> $GITHUB_ENV
           echo 'LATEST_DESCRIPTION<<"EOT"' >> $GITHUB_OUTPUT
-          cat latest_description.txt >> $GITHUB_OUTPUT
+          jq -r ".info.description" changelog.json >> $GITHUB_OUTPUT
           echo '"EOT"' >> $GITHUB_OUTPUT
-          latest_version=$(poetry run changelog2version --changelog_file changelog.md --print | python -c "import sys, json; print(json.load(sys.stdin)['info']['version'])")
-          echo "latest_version=$latest_version" >> $GITHUB_ENV
+          echo "latest_version=$(jq -r '.info.version' changelog.json)" >> $GITHUB_ENV
       - name: Build package
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         run: |
           poetry run changelog2version \
             --changelog_file changelog.md \
@@ -55,13 +61,15 @@ jobs:
             --debug
           poetry build
       - name: Publish package
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         uses: pypa/gh-action-pypi-publish@release/v1.5
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
           skip_existing: true
           verbose: true
           print_hash: true
       - name: Create Release
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-release.yaml

@@ -33,17 +33,23 @@ jobs:
           poetry run changelog-generator \
             changelog changelog.md \
             --snippets=.snippets \
-            --in-place
+            --in-place \
+            --no-internal
       - name: Parse changelog
         id: parse_changelog
         run: |
-          poetry run changelog2version --changelog_file changelog.md --print | python -c "import sys, json; print(json.load(sys.stdin)['info']['description'])" > latest_description.txt
+          poetry run changelog2version \
+            --changelog_file changelog.md \
+            --output changelog.json \
+            --print \
+            --debug
+          echo "CHANGELOG_JSON=$(jq -c . < changelog.json)" >> $GITHUB_ENV
           echo 'LATEST_DESCRIPTION<<"EOT"' >> $GITHUB_OUTPUT
-          cat latest_description.txt >> $GITHUB_OUTPUT
+          jq -r ".info.description" changelog.json >> $GITHUB_OUTPUT
           echo '"EOT"' >> $GITHUB_OUTPUT
-          latest_version=$(poetry run changelog2version --changelog_file changelog.md --print | python -c "import sys, json; print(json.load(sys.stdin)['info']['version'])")
-          echo "latest_version=$latest_version" >> $GITHUB_ENV
+          echo "latest_version=$(jq -r '.info.version' changelog.json)" >> $GITHUB_ENV
       - name: Build package
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         run: |
           poetry run changelog2version \
             --changelog_file changelog.md \
@@ -53,9 +59,11 @@ jobs:
             --debug
           poetry build
       - name: Test built package
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         run: |
           twine check dist/*.tar.gz
       - name: Archive build package artifact
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         uses: actions/upload-artifact@v4
         with:
           # https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
@@ -64,6 +72,7 @@ jobs:
           path: dist/*.tar.gz
           retention-days: 14
       - name: Publish package
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         uses: pypa/gh-action-pypi-publish@release/v1.5
         with:
           repository_url: https://test.pypi.org/legacy/
@@ -72,6 +81,7 @@ jobs:
           verbose: true
           print_hash: true
       - name: Create Prerelease
+        if: ${{ !contains(fromJson(env.CHANGELOG_JSON).info.meta.scope, 'internal') }}
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.snippets/23.md

@@ -0,0 +1,10 @@
+## Document and use no-internal option
+<!--
+type: feature
+scope: internal
+affected: all
+-->
+
+- Document `--no-internal` option in `README`
+- Use `jq` instead of complex Python based `changelog.json` parsing in `release` and `test-release` workflows
+- Skip building, testing, publishing and creating (pre)releases if the latest change was marked as `internal`

README.md

@@ -98,6 +98,11 @@ version entries and version bumps multiple times otherwise.*
 changelog-generator changelog changelog.md --snippets=.snippets [--in-place]
 ```
 
+The option `--no-internal` ignores all snippets with scope `internal` during
+the changelog generation. This is useful if those changes are not affecting
+the "product" like internal documentation changes or similar things, which e.g.
+do not require a deployment.
+
 ### Parse
 
 Parse an existing snippet file and return the data as JSON without indentation
@@ -163,7 +168,8 @@ jobs:
           changelog-generator \
             changelog changelog.md \
             --snippets=.snippets \
-            --in-place
+            --in-place \
+            --no-internal
 ```
 
 #### Other
@@ -173,7 +179,8 @@ pip install snippets2changelog
 changelog-generator \
   changelog changelog.md \
   --snippets=.snippets \
-  --in-place
+  --in-place \
+  --no-internal
 ```
 
 ## Contributing
@@ -227,6 +234,12 @@ not require any changes by the user to keep the system running after upgrading.
 requires the user to perform additional tasks, adopt his currently running
 code or in general can't be used as is anymore.
 
+The scope of a change shall either be:
+- `internal` if no new deployment is required for this change, like updates in
+the documentation for example
+- `external` or `all` if this change affects the public API of this package or
+requires a new tag and deployment for any other reason
+
 The changelog entry shall be short but meaningful and can of course contain
 links and references to other issues or PRs. New lines are only allowed for a
 new bulletpoint entry. Usage examples or other code snippets should be placed