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

Switch to unclog for changelog management #14782

Merged
merged 1 commit into from
Jan 14, 2025
Merged

Switch to unclog for changelog management #14782

merged 1 commit into from
Jan 14, 2025

Conversation

kasey
Copy link
Contributor

@kasey kasey commented Jan 8, 2025

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:

  • A changelog fragment porting the current Unreleased section of the changelog to a single fragment file.
  • Edits to the current changelog to remove the Unreleased section.
  • Edits to the the CONTRIBUTING.md document linking to the unclog 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 the unclog documentation for more details.

Acknowledgements

  • I have read CONTRIBUTING.md.
  • I have made an appropriate entry to CHANGELOG.md.
  • I have added a description to this PR with sufficient context for reviewers to understand this PR.

@kasey kasey requested a review from a team as a code owner January 8, 2025 21:46
kasey added a commit to kasey/prysm that referenced this pull request Jan 9, 2025
Copy link
Member

@nisdas nisdas left a 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 ?

@kasey
Copy link
Contributor Author

kasey commented Jan 13, 2025

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 CHANGELOG.md will always reflect the latest release, and unreleased changes will be in the changelog directory - there won't be an "unreleased" section any longer. If it turns out to be confusing to maintain the historical changelog in version control like this we can just remove it. But I think it seems valuable to preserve it here as a "backup" vs trusting github release mechanism to preserve the history.

@kasey kasey enabled auto-merge January 13, 2025 22:24
@kasey kasey force-pushed the changelog-tool branch 4 times, most recently from 4e10c2c to 79f14a8 Compare January 13, 2025 23:10
Copy link
Member

@prestonvanloon prestonvanloon left a 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
Copy link
Member

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.

https://docs.github.com/en/actions/administering-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy

@kasey kasey added this pull request to the merge queue Jan 14, 2025
Merged via the queue into develop with commit 2000ef4 Jan 14, 2025
15 checks passed
@kasey kasey deleted the changelog-tool branch January 14, 2025 18:29
syjn99 pushed a commit to syjn99/prysm that referenced this pull request Jan 14, 2025
Co-authored-by: Kasey Kirkham <kasey@users.noreply.github.com>
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.

3 participants