From 720387b7d636e1e3b3bf5f693da79a059fd17807 Mon Sep 17 00:00:00 2001 From: Nikhil Woodruff Date: Fri, 16 May 2025 12:03:14 +0100 Subject: [PATCH 1/3] Add changelog entry test and documentation Fixes #137 --- .github/workflows/changelog_entry.yaml | 28 ++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/changelog_entry.yaml diff --git a/.github/workflows/changelog_entry.yaml b/.github/workflows/changelog_entry.yaml new file mode 100644 index 00000000..69d5e7d4 --- /dev/null +++ b/.github/workflows/changelog_entry.yaml @@ -0,0 +1,28 @@ +name: Changelog Entry Check + +on: + pull_request: + branches: [ main ] + +jobs: + check-changelog-entry: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Check for changelog entry + run: | + if [ ! -f "changelog_entry.yaml" ]; then + echo "Error: changelog_entry.yaml file is missing." + echo "Please add a changelog_entry.yaml file at the root of the repository." + exit 1 + fi + + # Check if the file is empty + if [ ! -s "changelog_entry.yaml" ]; then + echo "Error: changelog_entry.yaml file is empty." + echo "Please add content to the changelog_entry.yaml file." + exit 1 + fi + + echo "Changelog entry found and is not empty." \ No newline at end of file From c420243172ac71691885b0b7526c0a825b7cc36d Mon Sep 17 00:00:00 2001 From: Nikhil Woodruff Date: Fri, 16 May 2025 12:05:11 +0100 Subject: [PATCH 2/3] Add versioning --- .github/workflows/changelog_entry.yaml | 2 +- changelog_entry.yaml | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/changelog_entry.yaml b/.github/workflows/changelog_entry.yaml index 69d5e7d4..cfb352c9 100644 --- a/.github/workflows/changelog_entry.yaml +++ b/.github/workflows/changelog_entry.yaml @@ -1,4 +1,4 @@ -name: Changelog Entry Check +name: Changelog entry on: pull_request: diff --git a/changelog_entry.yaml b/changelog_entry.yaml index e69de29b..2116320f 100644 --- a/changelog_entry.yaml +++ b/changelog_entry.yaml @@ -0,0 +1,4 @@ +- bump: patch + changes: + added: + - Changelog entry check. From 991863fdc14ce960a284ab2c68d65d268c609f5e Mon Sep 17 00:00:00 2001 From: Nikhil Woodruff Date: Fri, 16 May 2025 12:05:54 +0100 Subject: [PATCH 3/3] Adjust job name --- .github/workflows/changelog_entry.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/changelog_entry.yaml b/.github/workflows/changelog_entry.yaml index cfb352c9..d0eb8574 100644 --- a/.github/workflows/changelog_entry.yaml +++ b/.github/workflows/changelog_entry.yaml @@ -1,4 +1,4 @@ -name: Changelog entry +name: Versioning on: pull_request: @@ -6,6 +6,7 @@ on: jobs: check-changelog-entry: + name: Changelog entry check runs-on: ubuntu-latest steps: - uses: actions/checkout@v3