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 a RELEASE.md describing how to release a new version of CF #371

Open
davidhassell opened this issue Jul 28, 2022 · 12 comments · May be fixed by #498
Open

Add a RELEASE.md describing how to release a new version of CF #371

davidhassell opened this issue Jul 28, 2022 · 12 comments · May be fixed by #498
Labels
GitHub Improvement to how we use GitHub for this repository

Comments

@davidhassell
Copy link
Contributor

After CF-1.9 was released the release procedure was written up, but never made to a PR. Here it is now, in time for CF-1.10.

@davidhassell davidhassell added the GitHub Improvement to how we use GitHub for this repository label Jul 28, 2022
@erget
Copy link
Member

erget commented Jul 28, 2022

Hi @davidhassell I made some changes and also inserted some comments - have a look and see what you think :)

@erget
Copy link
Member

erget commented Aug 15, 2022

Additional changes concerning keeping contributor list up to date agreed in cf-convention/cf-convention.github.io#230. These were introduced in 0b20db2 and bf274bc

@JonathanGregory
Copy link
Contributor

In CONTRIBUTING.md we have

When an issue and accompanying pull request concludes with an agreed change to the conventions, the pull request is merged into the master branch according to the Rules for CF Convention Changes.
The pull request is merged by a member of the Governance Panel or the CF Conventions and Standard Names Committee. The person who merges the pull request also closes the issue.

Following #345 agreed last week, we should add here:

The issue should be given the change agreed label, and the pull request should be given the next release number as a milestone.

I suggest that this sentence or something like it should be inserted between the other two.

Jonathan

@erget
Copy link
Member

erget commented Aug 22, 2022

@JonathanGregory that looks fine for me, I would approve that.

BTW your note reminds me that we have yet to align the terminology everywhere of using "main" rather than "master" as branch name; I've submitted #376 to correct this in CONTRIBUTING.md, somehow I missed that when implementing cf-convention/discuss#125. Would appreciate if somebody takes a look at those minor but important changes.

@JonathanGregory
Copy link
Contributor

I have inserted a list of tasks, because I thought that made it clearer. Please see this PR.

@erget
Copy link
Member

erget commented Aug 23, 2022

Now this issue has produced 3 PRs. One's already merged because it was a simple error. Are the other 2 agreed? If they are, we could merge them sequentially, or merge 1 into the other and then merge the whole shebang when that's done. Both open PRs are valuable in my view and should be merged once it's clear that they're agreed (from my perspective that could be the case now, but others may disagree).

I believe the cleanest thing would be

Does that make sense?

@davidhassell
Copy link
Contributor Author

davidhassell commented Aug 23, 2022

Sounds good. Edit Just to be clear, "that PR" of the first action is #377 ? I see it now: davidhassell#4. More edits: now merged!

@davidhassell
Copy link
Contributor Author

(premature send) .... also, might be good to note that we only intend to merge #372 after we've used it for 1.10, as only then do we know it works (#372 (comment))

@erget
Copy link
Member

erget commented Aug 23, 2022

Sounds good.Just to be clear, "that PR" of the first action is #377 ?

Yes.

(premature send) .... also, might be good to note that we only intend to merge #372 after we've used it for 1.10, as only then do we know it works (#372 (comment))

I'd forgotten about that, absolutely right.

@JonathanGregory JonathanGregory changed the title Add a RELEASE.md descrihing how to release a new version of CF Add a RELEASE.md describing how to release a new version of CF Sep 10, 2022
@davidhassell davidhassell linked a pull request Dec 5, 2023 that will close this issue
4 tasks
@davidhassell davidhassell linked a pull request Dec 5, 2023 that will close this issue
4 tasks
@larsbarring
Copy link
Contributor

Hi @davidhassell I just had quick look at your new PR #498. From my outside perspective it looks good, but I guess only you and other release manages can judge. Nevertheless, here are two small observations:

  • The release date, that I tried to automate in issue #457 / PR#475 didn't work out in the end (hence cf-convention.github.io/428) I am not sure whether this automation could be fixed, or if the manual step needs to be recorded in the procedure.
  • The released version number, and the new draft version number, appears at quite a few places. Is this something that could be further automated ?

@JonathanGregory
Copy link
Contributor

Once a release is done, we need a milestone for the next one. I have just created the 1.12 milestone in order to attribute a PR to it.

@davidhassell
Copy link
Contributor Author

Thanks, @JonathanGregory, creating the next milestone has been added (0d77329).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GitHub Improvement to how we use GitHub for this repository
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants