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

Change the way version tagging works #1825

Open
lmoureaux opened this issue Feb 21, 2023 · 1 comment
Open

Change the way version tagging works #1825

lmoureaux opened this issue Feb 21, 2023 · 1 comment
Labels
enhancement New feature or request tools Issues related to mp, ruledit, etc along with CI and build tools.

Comments

@lmoureaux
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The current way of doing versions has several issues:

  • The release notes are not transparent
  • We have difficulties getting AutoRevision to work properly in all cases (see AutoRevision update #1820 for latest attempt)

I think this is due to a fundamental problem with the way we try to handle this.

Describe the solution you'd like

A new version would be made as follows:

  • Create a new PR with a distinctive format such as a version tag
  • In the PR, create and fill a file NEWS.md with the release notes
  • In the PR, update AutoRevision.txt to the new version
  • Upon merging, an automatic action starts a new release at the tip of the branch, adds the release notes from NEWS.md
  • The release is made public automatically once all binary packages are available

This way, the release will always be made from a commit with the correct version.

Describe alternatives you've considered

Current one, but seems fundamentally broken.

Additional context
Add any other context or screenshots about the feature request here.

@lmoureaux lmoureaux added enhancement New feature or request tools Issues related to mp, ruledit, etc along with CI and build tools. labels Feb 21, 2023
@jwrober
Copy link
Collaborator

jwrober commented Apr 24, 2023

The workflow I use for a release today makes doing all of this a bit difficult. Once we get a few PRs done I typically open a draft release and begin the process of capturing the closed PRs and organizing them into relevant sections. I keep a note at the top to help me remember what the last PR ID was that was added to the draft release. This helps with the counting effort as part of our documented release process. Doing it this way "feels" easier than holding a draft PR open or some such with commits to a NEWS.md file.

So what if we changed the order of operations a bit? Get rid of the action to auto-create the PR for the update to AutoRevision.txt at the release tag event, and instead add a manual update to AutoRevision.txt as a precursor step to tagging the release. With the file in the repo at HEAD, the existing code should find the appropriate tag to set the version correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request tools Issues related to mp, ruledit, etc along with CI and build tools.
Projects
None yet
Development

No branches or pull requests

2 participants