Skip to content

Conversation

@Squirrel18
Copy link
Contributor

@Squirrel18 Squirrel18 commented Jan 16, 2026

Description:

This PR is part of the new release process: #10 and adds a new workflow to verify that changelog.d entries have been added as part of the changes in a PR. All changes in a PR should include an entry describing the nature of the change using Scriv, this enforces Scriv to be used, maintaining an up-to-date changelog and applying good practices when opening PRs.

Test:

  1. Create a PR without any Scriv entries.
  2. Check that the GH action fails like this: https://github.com/Pearson-Advance/secure-cloudfront-video/actions/runs/21085416341/job/60647776979?pr=17

Notes:

  • It's necessary to add github.head_ref to the checkout Action so it can use the branch of the PR instead of the SHA ref.
  • To verify that changelog.d entries have been added, a simple grep command is used with a regular expression: grep -q "^changelog\.d/.*\.md$". To make this more robust, we would require to interact with Scriv file naming pattern increasing the complexity of this Action. For now this is the least we can do to perform the check.

Reviewers:

@Squirrel18 Squirrel18 marked this pull request as draft January 16, 2026 22:36
@Squirrel18 Squirrel18 marked this pull request as ready for review January 19, 2026 16:42
@MAAngamarca
Copy link

MAAngamarca commented Jan 28, 2026

LGTM.
Additional question, Should the workflow verify that the change log file is new and has not been modified? @Squirrel18

@Squirrel18
Copy link
Contributor Author

LGTM. Additional question, Should the workflow verify that the change log file is new and has not been modified? @Squirrel18

Are you suggesting it to avoid direct changes in the CHANGELOG.md file? or why are you suggesting it? @MAAngamarca

@MAAngamarca
Copy link

yes, to avoid direct changes in that file. @Squirrel18

@Squirrel18 Squirrel18 force-pushed the dqe/check-scriv-entries branch from dd7cfaf to 97330b1 Compare February 4, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants