You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.MD
+34-11Lines changed: 34 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,10 @@
1
1
# Releasing a new version of FAIR Connect
2
2
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
+
3
8
## 1. Verify milestone readiness
4
9
5
10
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
63
68
64
69
7. Continue to the next step once all workflows finish.
65
70
66
-
## 5. Create a new release on GitHub and update CHANGELOG.md
71
+
## 5. Create a new release on GitHub
67
72
68
73
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).
69
74
@@ -79,25 +84,43 @@ Once the milestone contains no open issues or pull requests, the release is read
79
84
- Leave **Previous tag** set to `Auto`.
80
85
- Click **Generate release notes**.
81
86
- 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.
83
88
84
89
> [!TIP]
85
90
> You can add additional information directly in the **Describe this release** field.
86
91
> If a teammate is preparing a release post for FAIR.pm, coordinate with them to include any relevant details.
87
92
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.
89
114
90
-
7. Check **Create a discussion for this release** and choose the **Announcements** category.
115
+
2. Check **Set as the latest release**.
91
116
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.
93
118
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.
95
120
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.
99
122
100
-
11. Verify successful release
123
+
6. Verify the release:
101
124
- Visit the [Releases page](https://github.com/fairpm/fair-plugin/releases) to confirm latest release.
102
125
- 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