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

Proposal for CHANGES change #1207

Open
chayim opened this issue Jul 11, 2023 · 4 comments
Open

Proposal for CHANGES change #1207

chayim opened this issue Jul 11, 2023 · 4 comments

Comments

@chayim
Copy link
Contributor

chayim commented Jul 11, 2023

Given how we now handle CHANGES< and using the release-drafter, we have a chicken and egg issue. The release drafter handles our release notes now. But the merge for a VERSION is responsible for updating the CHANGES file. We can continue to manually update the CHANGES file prior to release, but that's less than ideal. We can ask/continue to ask the community to update the CHANGES file, but that's a different barrier to entry.

Proposal:

  • Merges to master update the CHANGES file post-merge. This means a CI run on master, after something has been pushed to master.
  • Changes matching some sort of VERSIONING title updates CHANGES, specifically to insert the version number and date, maintaining what we have.
  • Optional (I don't personally see the value): We can pre-include a link to the release notes that will be generated for the version.
  • Release are just tags, via the drafter. No changes.

Downside

  • Some people dislike automatic updates to master (I'm not one of them)
  • The formatting present from the release-drafter wont' be present.

@yossigo @michael-grunder WDYT?

@chayim
Copy link
Contributor Author

chayim commented Jul 11, 2023

@uglide WDYT?

@michael-grunder
Copy link
Collaborator

This seems reasonable to me.

I don't mind merges directly to master if it isn't changing any code.

@chayim
Copy link
Contributor Author

chayim commented Jul 12, 2023

The only kicker is that means master git log is polluted with 'UPDATING CHANGES' type merges. The flip side is that we tried doing this in branches elsewhere, as parts of PRs - and frankly it makes merging awful (almost always a conflict, due to multiple merges). Still - I'm pro

@chayim
Copy link
Contributor Author

chayim commented Jul 13, 2023

@dvora-h so that you see this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants