Skip to content

New version release procedure#588

Open
davidhassell wants to merge 12 commits intocf-convention:mainfrom
davidhassell:release-CF-1.12
Open

New version release procedure#588
davidhassell wants to merge 12 commits intocf-convention:mainfrom
davidhassell:release-CF-1.12

Conversation

@davidhassell
Copy link
Contributor

See issue #371 for discussion of these changes.

Release checklist

  • Authors updated in cf-conventions.adoc? Add in two places: on line 3 and under .Additional Authors in About the authors.
  • Next version in cf-conventions.adoc up to date? Versioning inspired by SemVer.
  • history.adoc up to date?
  • Conformance document up to date?

For maintainers

After the merge remember to delete the source branch.
Tags are set at the conclusion of the annual meeting; until then, main always is a draft for the next version.

RELEASE.md Outdated

## Copy the new documents to the website repository

Go to your fork of https://github.com/cf-convention/cf-convention.github.io, create a new branch from "main", copy the new documents into this branch and submit the changes as a puull request back to https://github.com/cf-convention/cf-convention.github.io. The following is an example of how this may be done, but other git formulations are possible:
Copy link
Contributor

Choose a reason for hiding this comment

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

puull

@davidhassell davidhassell linked an issue Jan 24, 2025 that may be closed by this pull request
@cofinoa
Copy link
Contributor

cofinoa commented Mar 4, 2025

@davidhassell to me this PR it's ready to be merged

- "Choose a tag" for the new version on the "main" branch: The tag should be called `v<VN>.0`, substituting `<VN>` with the release version (e.g. `v1.12.0`).
- Set the release title to `CF-<VN>`, substituting `<VN>` the release version (e.g. `CF-1.12`).
- Click "Generate release notes". This will automatically generate a description of the release.
- Edit the description to remove the list of contributors, instead adding any new people who have made substantive contributions to the list at http://cfconventions.org/conventions_contributors.html.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the same thing as at line 134?

- In file **history.adoc**, insert a new heading at the top of the section: `=== Working version (most recent first)`

- For any issue which has been incorporated in the new release:
- If the issue has a `new contributor` label, add the new contributor(s) to the list at https://cfconventions.org/conventions_contributors.html.
Copy link
Contributor

Choose a reason for hiding this comment

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

See line 95


- For any issue which has been incorporated in the new release:
- If the issue has a `new contributor` label, add the new contributor(s) to the list at https://cfconventions.org/conventions_contributors.html.
- Ensure that the issue is closed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add the change agreed label to the issue, if not already there.

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.

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

3 participants