Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to changelog enforcer v3 (>= v3.3.2). #41

Merged
merged 6 commits into from Mar 29, 2023

Conversation

tdilauro
Copy link
Contributor

@tdilauro tdilauro commented Mar 11, 2023

Description

  • Upgrades the dangoslen/changelog-enforcer GitHub action to (at least) v3.3.2 via the v3 major release designation.
  • Removes the use of actions/checkout GH action in support of the changelog enforcer action, since the action no longer relies on it as of v3.0.0.

Motivation and Context

We are moving to new GitHub Actions environment files and were seeing deprecation warnings for V3 of the action. [Notion]

How Has This Been Tested?

The CI workflow runs at pull request time, so will review CI output to verify that this is working as expected.

Checklist:

  • N/A I have updated the documentation accordingly.
  • All new and existing tests passed.

@tdilauro tdilauro added the no-changelog Changelog not expected to change (e.g., CI changes) label Mar 11, 2023
@tdilauro tdilauro closed this Mar 11, 2023
@tdilauro tdilauro reopened this Mar 11, 2023
@tdilauro tdilauro removed the no-changelog Changelog not expected to change (e.g., CI changes) label Mar 11, 2023
@tdilauro
Copy link
Contributor Author

changelog-enforcer still produces the deprecated behavior. It appears to do this only when failing the job and producing it's error message. If the PR is re-opened with a no-changelog label (which produces the skipLabels behavior and won't fail the job), then the deprecation warning does not appear.

I added a couple of comments on an issue in the action's home repo.

@tdilauro
Copy link
Contributor Author

Without the no-changelog label and the skipLabels behavior, but providing an updated changelog, also results in NO Warning: or Error:. So, it appears that the deprecated behavior appears only on the failure path and not on any of the happy paths.

@tdilauro
Copy link
Contributor Author

Adding the no-changelog label back in and removing the fake changelog update.

@tdilauro tdilauro added the no-changelog Changelog not expected to change (e.g., CI changes) label Mar 11, 2023
@tdilauro tdilauro force-pushed the feature/upgrade-to-changelog-enforcer-3.3.0 branch from 84618bc to ecda705 Compare March 11, 2023 03:56
@tdilauro tdilauro closed this Mar 11, 2023
@tdilauro tdilauro reopened this Mar 11, 2023
@tdilauro tdilauro marked this pull request as draft March 11, 2023 04:12
@tdilauro tdilauro removed the no-changelog Changelog not expected to change (e.g., CI changes) label Mar 13, 2023
@tdilauro tdilauro closed this Mar 13, 2023
@tdilauro tdilauro reopened this Mar 13, 2023
@tdilauro tdilauro force-pushed the feature/upgrade-to-changelog-enforcer-3.3.0 branch from 9f88e97 to bbfd7d2 Compare March 16, 2023 00:39
@tdilauro tdilauro closed this Mar 16, 2023
@tdilauro tdilauro reopened this Mar 16, 2023
@tdilauro tdilauro closed this Mar 16, 2023
@tdilauro tdilauro reopened this Mar 16, 2023
@tdilauro
Copy link
Contributor Author

The v3.3.2 release emits the correct error message without the deprecation message.

Updates Changelog
No update to CHANGELOG.md found!

@tdilauro
Copy link
Contributor Author

Using the major version syntax also emits the correct error message without the deprecation message. And it allows us to pick up future updates.

Run dangoslen/changelog-enforcer@v3
Skip Labels: no-changelog
Changelog Path: CHANGELOG.md
Missing Update Error Message: No update to CHANGELOG.md found!
Expected Latest Version: 
Version Pattern: ^## \[((v|V)?\d*\.\d*\.\d*-?\w*|unreleased|Unreleased|UNRELEASED)\]
Error: No update to CHANGELOG.md found!

@tdilauro tdilauro added the no-changelog Changelog not expected to change (e.g., CI changes) label Mar 26, 2023
@tdilauro tdilauro changed the title Upgrade to changelog enforcer 3.3.0. Upgrade to changelog enforcer v3 (>= v3.3.2). Mar 26, 2023
@tdilauro
Copy link
Contributor Author

This looks good. Setting no-changelog label and closing/re-opening one last time to get clean tests. 🤞🏽

@tdilauro tdilauro closed this Mar 26, 2023
@tdilauro tdilauro reopened this Mar 26, 2023
@tdilauro tdilauro marked this pull request as ready for review March 26, 2023 22:28
Copy link
Member

@jonathangreen jonathangreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow. That PR history is a journey...

@tdilauro tdilauro merged commit 6648eca into main Mar 29, 2023
7 of 8 checks passed
@tdilauro tdilauro deleted the feature/upgrade-to-changelog-enforcer-3.3.0 branch March 29, 2023 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Changelog not expected to change (e.g., CI changes)
Projects
None yet
2 participants