-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Switch to unclog for changelog management #14782
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we remove the current changelog.md file ?
This PR removes all changes to it since the last release. The plan going forward is to commit the updated changelog each time we run the release command, meaning the top section of |
4e10c2c
to
79f14a8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One comment, otherwise LGTM
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
repository: OffchainLabs/unclog | ||
name: unclog | ||
run-id: 12679708867 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed offline that the maximum artifact retention period is 90 days so we will need to address this in a follow up.
Co-authored-by: Kasey Kirkham <kasey@users.noreply.github.com>
What type of PR is this?
Other
What does this PR do? Why is it needed?
This PR replaces the current changelog PR check with a new workflow using our changelog management tool(unclog)[https://github.com/OffchainLabs/unclog] tool. Please see the
unclog
documentation for full details on how to satisfy the requirements of this workflow. In addition to the workflow changes, this PR contains:Unreleased
section of the changelog to a single fragment file.Unreleased
section.CONTRIBUTING.md
document linking to theunclog
documentation.Which issues(s) does this PR fix?
The main pain point in our changelog management workflow is conflicts in
CHANGELOG.md
across PR branches causing headaches when merging PRs to develop. See theunclog
documentation for more details.Acknowledgements