Skip to content

Commit 8f3ab3c

Browse files
authored
Clarify steps in RELEASE.MD (#407)
Signed-off-by: Carrie Dils <carriedils@gmail.com>
1 parent d266c5c commit 8f3ab3c

File tree

1 file changed

+34
-11
lines changed

1 file changed

+34
-11
lines changed

RELEASE.MD

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Releasing a new version of FAIR Connect
22

3+
## 0. Ensure adequate permissions
4+
To perform a release of FAIR Connect, you need the following:
5+
- `write` or higher permissions on the [FAIR Connect repository](https://github.com/fairpm/fair-plugin)
6+
- `maintain` or higher permissions on the [TSC repository](https://github.com/fairpm/tsc) (this is required to post a Discussion in the Announcements category per step 7.3.)
7+
38
## 1. Verify milestone readiness
49

510
Before starting the release process, ensure that the milestone for the upcoming release is finalized and clear.
@@ -63,7 +68,7 @@ Once the milestone contains no open issues or pull requests, the release is read
6368

6469
7. Continue to the next step once all workflows finish.
6570

66-
## 5. Create a new release on GitHub and update CHANGELOG.md
71+
## 5. Create a new release on GitHub
6772

6873
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).
6974

@@ -79,25 +84,43 @@ Once the milestone contains no open issues or pull requests, the release is read
7984
- Leave **Previous tag** set to `Auto`.
8085
- Click **Generate release notes**.
8186
- Review and edit the generated notes as needed.
82-
- Copy/paste the release notes into the **CHANGELOG.md** file under the new version heading and date.
87+
- Click the **Save draft** button.
8388

8489
> [!TIP]
8590
> You can add additional information directly in the **Describe this release** field.
8691
> If a teammate is preparing a release post for FAIR.pm, coordinate with them to include any relevant details.
8792
88-
6. Check **Set as the latest release**.
93+
## 6. Update the changelog before publishing the GitHub release
94+
95+
1. In a new browser tab, open [`CHANGELOG.md`](/CHANGELOG.md).
96+
97+
2. Click the pencil icon to edit the file directly in the browser.
98+
99+
3. Copy the release notes into `CHANGELOG.md` under the new version heading and date (e.g., `1.2.0 / 2025-12-11`).
100+
101+
4. Click the **Commit changes** button. In the panel that opens:
102+
- Select **Create a new branch for this commit and start a pull request**.
103+
- Enter a branch name or use the default (e.g., `update-changelog-1.2.0`).
104+
- Click the **Sign off and propose changes** button.
105+
106+
5. Create a pull request for the updated `CHANGELOG.md` file.
107+
108+
6. Review, approve, and merge the pull request.
109+
110+
111+
## 7. Finalize and publish the release
112+
113+
1. Return to the **Draft Release** page.
89114

90-
7. Check **Create a discussion for this release** and choose the **Announcements** category.
115+
2. Check **Set as the latest release**.
91116

92-
8. In a new browser tab, go to the repository’s **Actions** tab and confirm all workflows have completed.
117+
3. Check **Create a discussion for this release** and choose the **Announcements** category.
93118

94-
9. Return to the **Draft Release** page and click **Publish release**.
119+
4. In a new browser tab, go to the repository’s **Actions** tab and confirm all workflows have completed.
95120

96-
10. To verify release processing:
97-
- Go to the **Actions** tab.
98-
- Once workflows complete, the release is live.
121+
5. Return to the **Draft Release** page and click **Publish release**. This initiates the remaining release workflows.
99122

100-
11. Verify successful release
123+
6. Verify the release:
101124
- Visit the [Releases page](https://github.com/fairpm/fair-plugin/releases) to confirm latest release.
102125
- Check any site using FAIR Connect to ensure the new version is available.
103-
- Check the API response for the updated version number.
126+
- Verify the updated version number in the API response. (Example URL to check: https://api.fair.pm/git-updater/v1/update-api/?slug=fair-plugin)

0 commit comments

Comments
 (0)