From d617c1211b80f9d20761252c8accf43406ad9a5d Mon Sep 17 00:00:00 2001
From: "Felt, Nicholas" <nicholas.felt@tektronix.com>
Date: Wed, 21 Aug 2024 10:07:25 -0700
Subject: [PATCH] test: Update the workflow that tests the actions to always
 have dummy data in the changelog check action job

---
 .github/workflows/test-actions.yml | 18 +++++++++++++++-
 CHANGELOG.md                       | 33 ++++++++----------------------
 2 files changed, 26 insertions(+), 25 deletions(-)

diff --git a/.github/workflows/test-actions.yml b/.github/workflows/test-actions.yml
index 3f1a0ca9..923aa1a2 100644
--- a/.github/workflows/test-actions.yml
+++ b/.github/workflows/test-actions.yml
@@ -31,6 +31,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Overwrite CHANGELOG.md with dummy data
+        run: |
+          cat <<EOF > CHANGELOG.md
+          # Changelog
+          ---
+          ## Unreleased
+          Things to be included in the next release go here.
+          ### Added
+          - Something will be added
+          ---
+          ## v0.0.1
+          ### Added
+          - Something was done here in the past
+          EOF
       - uses: ./actions/find-unreleased-changelog-items
         with:
           release-level: patch
@@ -52,6 +66,7 @@ jobs:
           fail: true
       - name: Verify that the GITHUB_STEP_SUMMARY is not empty
         run: |
+          ls -l "$(dirname $GITHUB_STEP_SUMMARY)"
           if [ -s "$GITHUB_STEP_SUMMARY" ]; then
             echo "GITHUB_STEP_SUMMARY is not empty."
           else
@@ -66,10 +81,11 @@ jobs:
         with:
           update-pre-commit: true
           run-pre-commit: true
+          dependency-dict: '{"dev": ["pyright"]}'
           pre-commit-hook-skip-list: remove-tabs,forbid-tabs,check-readthedocs,check-dependabot,check-github-actions,check-github-workflows,commitizen,blacken-docs,yamlfix,hadolint,mdformat,markdown-link-check,check-poetry,toml-sort-fix,pyright,poetry-audit,ruff,ruff-format,docformatter
           export-dependency-groups: udd:actions/update-development-dependencies,cutv:actions/create-unique-testpypi-version,fci:actions/find-unreleased-changelog-items
   # Check that all jobs passed
-  check-tests-passed:
+  check-action-tests-passed:
     if: ${{ !cancelled() }}
     needs:
       - test-create-unique-testpypi-version
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7cb30170..b3aacde1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,17 +1,5 @@
 # Changelog
 
-The format is based on [Keep a Changelog](https://keepachangelog.com), and this
-project adheres to [Semantic Versioning](https://semver.org).
-
-Valid subsections within a version are:
-
-- Added
-- Changed
-- Deprecated
-- Removed
-- Fixed
-- Security
-
 ---
 
 ## Unreleased
@@ -20,15 +8,12 @@ Things to be included in the next release go here.
 
 ### Added
 
-- Added a reusable workflow to check the Python API for breaking changes: [`check-api-for-breaking-changes.yml`](./workflows/check-api-for-breaking-changes.md)
-- Added a reusable workflow to perform CodeQL analysis: [`codeql-analysis.yml`](./workflows/codeql-analysis.md)
-- Added a reusable workflow to enforce Open-Source community standards: [`enforce-community-standards.yml`](./workflows/enforce-community-standards.md)
-- Added a reusable workflow to build a Python package: [`package-build.yml`](./workflows/package-build.md)
-- Added a reusable workflow to publish a Python package to PyPI, GitHub Releases, and TestPyPI: [`package-release.yml`](./workflows/package-release.md)
-- Added a reusable workflow to upload a Python package to TestPyPI: [`package-testpypi.yml`](./workflows/package-testpypi.md)
-- Added a reusable workflow to publish API comparison results as a Pull Request comment: [`publish-api-comparison.yml`](./workflows/publish-api-comparison.md)
-- Added a reusable workflow to publish test results as a Pull Request comment: [`publish-test-results.yml`](./workflows/publish-test-results.md)
-- Added a reusable workflow to create a Software Bill of Materials (SBOM) and scan it: [`sbom-scan.yml`](./workflows/sbom-scan.md)
-- Added a reusable workflow to run tests and linting against Python package code: [`test-code.yml`](./workflows/test-code.md)
-- Added a reusable workflow to run documentation builds and tests for a Python package: [`test-docs.yml`](./workflows/test-docs.md)
-- Added a reusable workflow to update Python and `pre-commit` dependencies: [`update-python-and-pre-commit-dependencies.yml`](./workflows/update-python-and-pre-commit-dependencies.md)
+- Something will be added
+
+---
+
+## v0.0.1
+
+### Added
+
+- Something was done here in the past