Add RELEASE.md documenting the version release process#355
Merged
Conversation
Contributor
costdev
previously requested changes
Dec 10, 2025
RELEASE.MD
Outdated
| 1. From the repository’s main page, click the **Releases** link — or go directly to the [Releases page](https://github.com/fairpm/fair-plugin/releases). | ||
| 2. Click the **Draft a new release** button. | ||
| 3. In the **Select tag** field: | ||
| - select the tag that matches the version you just released (e.g., `1.2.0`). |
Member
There was a problem hiding this comment.
Suggested change
| - select the tag that matches the version you just released (e.g., `1.2.0`). | |
| - Select the tag that matches the version you just bumped to (e.g., `1.2.0`). |
cdils
commented
Dec 11, 2025
cdils
commented
Dec 11, 2025
Signed-off-by: Carrie Dils <[email protected]>
- Removes mention of POT file since this is now automated - Make milestone verification a prerequisite for releases Signed-off-by: Carrie Dils <[email protected]>
cdils
force-pushed
the
issue-354/release-docs
branch
from
48f77dc to
dd1f664
Compare
…release Signed-off-by: Carrie Dils <[email protected]>
joedolson
requested changes
Dec 22, 2025
Member
joedolson
left a comment
joedolson
left a comment
There was a problem hiding this comment.
I mean, just one little change.
Signed-off-by: Carrie Dils <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds
RELEASE.md, which documents the full maintainer release workflow for FAIR Connect.The guide provides step-by-step instructions for running release-related workflows, reviewing and merging automated PRs, updating POT files, creating GitHub releases, and performing optional milestone cleanup.
The goal is to ensure a consistent, repeatable release process and to make onboarding easier for future maintainers.
Included in this PR
RELEASE.mdfileAdditional improvements that may be added before merging
RELEASE.mddocument to supplement written steps.Future enhancements (out of scope for this PR)
Fixes #354