Update GitHub action versions used in workflows (tektronix#120)

* gh-actions(deps): Bump the gh-actions-dependencies group with 6 updates

Bumps the gh-actions-dependencies group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [github/codeql-action](https://github.com/github/codeql-action) | `2` | `3` |
| [dawidd6/action-download-artifact](https://github.com/dawidd6/action-download-artifact) | `2.28.0` | `3.0.0` |
| [hynek/build-and-inspect-python-package](https://github.com/hynek/build-and-inspect-python-package) | `1.5.4` | `2.0.0` |
| [python-semantic-release/python-semantic-release](https://github.com/python-semantic-release/python-semantic-release) | `8.5.0` | `8.5.1` |
| [actions/download-artifact](https://github.com/actions/download-artifact) | `3` | `4` |
| [actions/upload-artifact](https://github.com/actions/upload-artifact) | `3` | `4` |

Updates `github/codeql-action` from 2 to 3
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@v2...v3)

Updates `dawidd6/action-download-artifact` from 2.28.0 to 3.0.0
- [Release notes](https://github.com/dawidd6/action-download-artifact/releases)
- [Commits](dawidd6/action-download-artifact@v2.28.0...v3.0.0)

Updates `hynek/build-and-inspect-python-package` from 1.5.4 to 2.0.0
- [Release notes](https://github.com/hynek/build-and-inspect-python-package/releases)
- [Changelog](https://github.com/hynek/build-and-inspect-python-package/blob/main/CHANGELOG.md)
- [Commits](hynek/build-and-inspect-python-package@v1.5.4...v2.0.0)

Updates `python-semantic-release/python-semantic-release` from 8.5.0 to 8.5.1
- [Release notes](https://github.com/python-semantic-release/python-semantic-release/releases)
- [Changelog](https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md)
- [Commits](python-semantic-release/python-semantic-release@v8.5.0...v8.5.1)

Updates `actions/download-artifact` from 3 to 4
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v3...v4)

Updates `actions/upload-artifact` from 3 to 4
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v3...v4)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: gh-actions-dependencies
- dependency-name: dawidd6/action-download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: gh-actions-dependencies
- dependency-name: hynek/build-and-inspect-python-package
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: gh-actions-dependencies
- dependency-name: python-semantic-release/python-semantic-release
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: gh-actions-dependencies
- dependency-name: actions/download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: gh-actions-dependencies
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: gh-actions-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>

* ci: Test removing the files that store the previous changelog and release notes from git tracking.

* docs: Update changelog with information on the version bump for python-semantic-release.

* docs: Reverted some changes made during testing of workflow updates.

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <[email protected]>
Signed-off-by: qthompso <[email protected]>

.github/workflows/codeql-analysis.yml

@@ -24,11 +24,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           queries: security-extended,security-and-quality
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
         with:
           category: /language:${{matrix.language}}

.github/workflows/deploy-documentation.yml

@@ -10,8 +10,8 @@ concurrency:
 jobs:
   publish-docs:
     runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' }} && github.ref ==
-      'refs/heads/main'
+    if: github.repository == 'tektronix/tm_devices' && github.event.workflow_run.conclusion
+      == 'success' && github.ref == 'refs/heads/main'
     permissions:
       pages: write
       id-token: write
@@ -20,7 +20,7 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Download Artifact
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           run_id: ${{ github.event.workflow_run.id }}

.github/workflows/package-build.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: hynek/build-and-inspect-python-package@v1.5.4
+      - uses: hynek/build-and-inspect-python-package@v2.0.0
         id: build-pkg
       - name: Set up Python
         uses: actions/setup-python@v5

.github/workflows/package-release.yml

@@ -48,10 +48,9 @@ jobs:
       - name: Check for unreleased entries in the Changelog and copy files to templates
         run: |
           python scripts/check_unreleased_changelog_items.py
-          git add python_semantic_release_templates
           git config --global tag.gpgSign true
       - name: Python Semantic Release
-        uses: python-semantic-release/[email protected].0
+        uses: python-semantic-release/[email protected].1
         id: release
         with:
           force: ${{ inputs.release_level }}
@@ -74,7 +73,7 @@ jobs:
           ref: main  # Make sure to check out the latest commit on main, not the original commit that triggered the workflow
           fetch-depth: 0
       - name: Build package
-        uses: hynek/build-and-inspect-python-package@v1.5.4
+        uses: hynek/build-and-inspect-python-package@v2.0.0
   upload-testpypi:
     name: Upload package to TestPyPI
     needs: [pypi-build]
@@ -85,7 +84,7 @@ jobs:
       id-token: write
     steps:
       - name: Download built packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist
@@ -103,7 +102,7 @@ jobs:
       id-token: write
     steps:
       - name: Download built packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist
@@ -123,7 +122,7 @@ jobs:
           ref: main  # Make sure to check out the latest commit on main, not the original commit that triggered the workflow
           fetch-depth: 0
       - name: Download built packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist

.github/workflows/package-testpypi.yml

@@ -32,7 +32,7 @@ jobs:
           python scripts/project_version.py --set-version=$NEW_VERSION
           echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
       - name: Build package
-        uses: hynek/build-and-inspect-python-package@v1.5.4
+        uses: hynek/build-and-inspect-python-package@v2.0.0
     outputs:
       built-version: ${{ steps.create-version.outputs.NEW_VERSION }}
   test-pypi-upload:
@@ -45,7 +45,7 @@ jobs:
       id-token: write
     steps:
       - name: Download built packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist

.github/workflows/test-code.yml

@@ -32,7 +32,7 @@ jobs:
           python -m pip install --upgrade tox tox-gh-actions
       - name: Run tox
         run: tox -v
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
           name: artifact_${{ matrix.platform }}_${{ matrix.python-version }}_tests_and_linting
@@ -59,7 +59,7 @@ jobs:
           python -m pip install --upgrade tox
       - name: Test
         run: tox -ve tests
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
           name: artifact_${{ matrix.os_name }}_tests

.github/workflows/test-docs.yml

@@ -41,7 +41,7 @@ jobs:
           type: zip
           filename: ${{ matrix.tox_env }}_results.zip
           path: .results_${{ matrix.tox_env }}/
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
           name: artifact_${{ matrix.tox_env }}

.gitignore

@@ -36,6 +36,8 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+python_semantic_release_templates/.previous_changelog_for_template.md
+python_semantic_release_templates/.previous_release_notes_for_template.md
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.pre-commit-config.yaml

@@ -122,7 +122,7 @@ repos:
         always_run: true
         args: [., --min=10]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.7
+    rev: v0.1.8
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

CHANGELOG.md

@@ -25,6 +25,7 @@ Things to be included in the next release go here.
 ### Changed
 
 - Switched to ruff's formatter instead of black's formatter for python code
+- Updated the version of `python-semantic-release` that is used to avoid needing to store a copy of the previous changelog in the repo
 
 ______________________________________________________________________
 

pyproject.toml

@@ -109,7 +109,7 @@ pytest-cov = ">=3.0.0"
 pytest-html = ">=4.0"
 pytest-order = ">=1.0.1"
 pytest-profiling = ">=1.7.0"
-python-semantic-release = ">=8.0"
+python-semantic-release = ">=8.5.1"
 ruff = ">=0.1.7"
 safety = ">=2.1.1"
 sphinx-autoapi = ">=2.0.0"