ci: fixes pipeline failures in docs (#1763)

* docs: updates python semantic release link The existing link is no longer reachable and returns a 404 Signed-off-by: Jennifer Power <[email protected]> * ci: updates github variable reference to use github.event.ref GITHUB_REF can't be used with the env context Signed-off-by: Jennifer Power <[email protected]> * fix: updates python test to only check the mike script on PRs Signed-off-by: Jennifer Power <[email protected]> * chore: removes the mike version check in python-test Testing locally would be simpler in this case. Signed-off-by: Jennifer Power <[email protected]> --------- Signed-off-by: Jennifer Power <[email protected]>
oscal-compass · Dec 3, 2024 · a1bc938 · a1bc938
1 parent 605c044
commit a1bc938
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/docs-update.yml b/.github/workflows/docs-update.yml
@@ -37,8 +37,10 @@ jobs:
       with:
         python-version: ${{ needs.set-versions.outputs.max }}
     - id: versions
+      env:
+        REF: ${{ github.event.ref }}
       run: |
-        mike_version=$(python ./scripts/mike_version_parse.py ${{ env.GITHUB_REF }})
+        mike_version=$(python ./scripts/mike_version_parse.py "$REF")
         echo "mver=$mike_version" >> $GITHUB_OUTPUT
   deploy-docs:
     runs-on: ubuntu-latest

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -43,7 +43,7 @@ Upon approval from reviewer(s), the working copy is squashed and merged into the
 Upon a cadence established by the maintainers, the develop branch is merged into the main branch and a new release is uniquely numbered and pushed to [pypi](https://pypi.org/project/compliance-trestle/).
 
 `trestle` employs `semantic release` to automatically control release numbering.
-Code deliveries should be tagged with prefix `fix:` for changes that are bug fixes or `feat:` for changes that are new features.  See [allowed_tags](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html#:~:text=The%20default%20configuration%20options%20for%20semantic_release.commit_parser.AngularCommitParser%20are%3A) for a list of supported tags.
+Code deliveries should be tagged with prefix `fix:` for changes that are bug fixes or `feat:` for changes that are new features.  See [allowed_tags](https://python-semantic-release.readthedocs.io/en/latest/commit_parsing.html#commit-parser-builtin-angular) for a list of supported tags.
 
 ### Trestle merging and release workflow