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

Update RELEASING with revisioning instructions #4105

Merged
merged 3 commits into from
Feb 23, 2024

Conversation

Lucsanszky
Copy link
Contributor

@Lucsanszky Lucsanszky commented Feb 21, 2024

Description

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. If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)
  • All visible changes are prepended to 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

@Lucsanszky
Copy link
Contributor Author

I will also add a section with general instructions to sum things up after the more specific step-by-step instructions and perhaps add the actual git commands in the general setup section but this is roughly it. Hopefully it is clear and detailed enough.

@Lucsanszky Lucsanszky force-pushed the lucsanszky/update-releasing branch 3 times, most recently from 30e9779 to 35e8328 Compare February 22, 2024 02:25
@Lucsanszky Lucsanszky marked this pull request as ready for review February 22, 2024 02:33
@Lucsanszky Lucsanszky requested a review from teodanciu February 22, 2024 02:33
@Lucsanszky Lucsanszky force-pushed the lucsanszky/update-releasing branch from 35e8328 to a45e82f Compare February 22, 2024 02:35
docs/RevisionHowto.md Outdated Show resolved Hide resolved
docs/RevisionHowto.md Outdated Show resolved Hide resolved
@teodanciu
Copy link
Contributor

These are great details, thank you for writing them down so thoroughly!
I just had a suggestion about switching the sections: starting with the overview of what the process is and when we need to do it, and then following with the example (maybe also, if possible, naming the specifics of the example, eg: creating a revision for this package at that commit), just so it's easier to understand for someone who is not familiar with revisions (like me 😬 )

@Lucsanszky Lucsanszky force-pushed the lucsanszky/update-releasing branch 2 times, most recently from 2e701a3 to 51f2628 Compare February 22, 2024 19:22
Copy link
Contributor

@teodanciu teodanciu left a comment

Choose a reason for hiding this comment

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

Looks good to me, awesome!

@Lucsanszky Lucsanszky force-pushed the lucsanszky/update-releasing branch from 51f2628 to b114aac Compare February 23, 2024 02:31
@Lucsanszky Lucsanszky force-pushed the lucsanszky/update-releasing branch from ea71cf7 to 0dec088 Compare February 23, 2024 02:37
@Lucsanszky Lucsanszky enabled auto-merge February 23, 2024 02:41
@Lucsanszky Lucsanszky merged commit 139346b into master Feb 23, 2024
13 checks passed
@neilmayhew neilmayhew deleted the lucsanszky/update-releasing branch March 8, 2024 21:07
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.

2 participants