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

Add an example on how to bump up versions in the changelog #3432

Merged
merged 3 commits into from
May 19, 2023

Conversation

lehins
Copy link
Collaborator

@lehins lehins commented May 19, 2023

Also chaneg the policy on where to add new entries in the changelog

Description

Slight improvement to RELEASING doc

Important change is the policy to add new entries in the changelog to the top. This turns out to be quite useful when a package is being released from behind master's HEAD.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated
  • When applicable, versions are updated in .cabal and CHANGELOG.md files according to the
    versioning process.
  • The version bounds in .cabal files for all affected packages are updated (See RELEASING.md)
  • Any changes are noted in the latest section of a CHANGELOG.md for the affected packages. New section is never added with the code changes. (See RELEASING.md)
  • 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 19, 2023 13:34
@lehins lehins force-pushed the lehins/add-example-to-versioning branch 2 times, most recently from 23e9fa6 to 56b1f88 Compare May 19, 2023 13:40
Copy link
Contributor

@aniketd aniketd left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you 🙌

@lehins lehins force-pushed the lehins/add-example-to-versioning branch from 56b1f88 to 363d1c7 Compare May 19, 2023 20:24
@lehins lehins enabled auto-merge May 19, 2023 20:24
@lehins lehins merged commit 2914f1d into master May 19, 2023
@iohk-bors iohk-bors bot deleted the lehins/add-example-to-versioning branch May 19, 2023 22:55
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