From 9c38fd9c6f28483ef4fddf9794c51ff718141fab Mon Sep 17 00:00:00 2001 From: TheGupta2012 Date: Fri, 20 Jun 2025 11:39:48 +0530 Subject: [PATCH 1/3] add changelog workflow --- .github/workflows/pr-compliance.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/pr-compliance.yml diff --git a/.github/workflows/pr-compliance.yml b/.github/workflows/pr-compliance.yml new file mode 100644 index 00000000..c4e2f852 --- /dev/null +++ b/.github/workflows/pr-compliance.yml @@ -0,0 +1,27 @@ +name: PR Compliance + +on: + pull_request_target: + branches: ['main'] + types: [opened, reopened, ready_for_review, synchronize] + +jobs: + remind: + name: Changelog + runs-on: ubuntu-latest + if: ${{ github.actor != 'dependabot' && github.actor != 'dependabot[bot]' && github.actor != 'github-actions' && github.actor != 'github-actions[bot]' && github.event.pull_request.draft == false }} + steps: + - uses: actions/checkout@v4 + - name: Changelog Reminder + uses: peterjgrainger/action-changelog-reminder@v1.3.0 + with: + changelog_regex: 'CHANGELOG.md' + customPrMessage: | + 👋 Hey there! It looks like the changelog might need an update. + + Please take a moment to edit the [`CHANGELOG.md`](/qBraid/qBraid/blob/main/CHANGELOG.md) with: + - A brief, one-to-two sentence summary of your changes. + - A link back to this PR for reference. + - (Optional) A small working example if you've added new features. + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From 9fc85656231bc5bcb531030747a9a5f1617a4000 Mon Sep 17 00:00:00 2001 From: TheGupta2012 Date: Fri, 20 Jun 2025 11:43:05 +0530 Subject: [PATCH 2/3] add changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb0c54c4..e00232ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ Types of changes: ### Added - A new discussion template for issues in pyqasm ([#213](https://github.com/qBraid/pyqasm/pull/213)) +- A github workflow for validating `CHANGELOG` updates in a PR ([#214](https://github.com/qBraid/pyqasm/pull/214)) ### Improved / Modified From cba2b6ba08119fd9e27cd471a583d6d1a9f7806c Mon Sep 17 00:00:00 2001 From: TheGupta2012 Date: Fri, 20 Jun 2025 11:44:34 +0530 Subject: [PATCH 3/3] fix link --- .github/workflows/pr-compliance.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-compliance.yml b/.github/workflows/pr-compliance.yml index c4e2f852..b30fe4e2 100644 --- a/.github/workflows/pr-compliance.yml +++ b/.github/workflows/pr-compliance.yml @@ -19,7 +19,7 @@ jobs: customPrMessage: | 👋 Hey there! It looks like the changelog might need an update. - Please take a moment to edit the [`CHANGELOG.md`](/qBraid/qBraid/blob/main/CHANGELOG.md) with: + Please take a moment to edit the [`CHANGELOG.md`](/qBraid/pyqasm/blob/main/CHANGELOG.md) with: - A brief, one-to-two sentence summary of your changes. - A link back to this PR for reference. - (Optional) A small working example if you've added new features.