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

Jump to bottom

Fixup release process #3407

Merged
merged 3 commits into from May 9, 2023
Merged

Fixup release process #3407

merged 3 commits into from May 9, 2023

Conversation

lehins
Copy link
Contributor

@lehins lehins commented May 8, 2023

Description

Minor improvements to the versioning and releasing documentation.

  • Creating a patch release was not properly documented, in particular how to create a PR and which base branch to use was not mentioned.
  • Per Sam's request, top level CHANGELOG.md now gets a deprecation notice
  • PR template now has more information, to avoid common mistakes for outside contributors.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated
  • Any changes are noted in the CHANGELOG.md for affected package
  • The version bounds in .cabal files are updated
  • Code is formatted with fourmolu (use scripts/fourmolize.sh)
  • Cabal files are formatted (use scripts/cabal-format.sh)
  • hie.yaml has been updated (use scripts/gen-hie.sh)
  • Self-reviewed the diff

@lehins lehins requested a review from a team as a code owner May 8, 2023 15:47
@lehins lehins force-pushed the lehins/fixup-release-process branch from 769420f to 840b692 Compare May 8, 2023 16:02
JaredCorduan
JaredCorduan approved these changes May 9, 2023
View reviewed changes
Copy link
Contributor

@JaredCorduan JaredCorduan left a comment

Choose a reason for hiding this comment

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

good stuff!

@lehins lehins merged commit d3f8c7e into master May 9, 2023
389 checks passed
@iohk-bors iohk-bors bot deleted the lehins/fixup-release-process branch May 9, 2023 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JaredCorduan JaredCorduan JaredCorduan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@lehins @JaredCorduan