Skip to content

Commit 3724d19

Browse files
Add release instructions
1 parent 4157410 commit 3724d19

File tree

4 files changed

+73
-6
lines changed

4 files changed

+73
-6
lines changed

sphinx/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Welcome to Specify Developer documentation!
4949
dev_process/dbgroups
5050
dev_process/individualdbs
5151
dev_process/dev_expectations
52+
processes/release_notes
5253

5354
.. toctree::
5455
:maxdepth: 1

sphinx/processes/changelog_add.png

179 KB
Loading

sphinx/processes/package_release.png

160 KB
Loading

sphinx/processes/release_notes.md

Lines changed: 72 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ These release notes are always packaged in [Markdown format](https://www.markdow
4040
* Batch Edit: Support for editing basic fields ((#5417)[https://github.com/specify/specify7/pull/5417])
4141
```
4242

43-
4. Create a new Markdown document using [VSCode](https://code.visualstudio.com/), [StackEdit](https://stackedit.io/), or a text editor of your choice with real-time Markdown preview. Copy and paste this basic structure into it:
43+
6. Create a new Markdown document using [VSCode](https://code.visualstudio.com/), [StackEdit](https://stackedit.io/), or a text editor of your choice with real-time Markdown preview. Copy and paste this basic structure into it:
4444

4545
```md
4646
## [7.10.2](https://github.com/specify/specify7/compare/v7.10.1...v7.10.2) (15 April 2025)
@@ -60,7 +60,7 @@ These release notes are always packaged in [Markdown format](https://www.markdow
6060
For more information about Specify 7, or about this release, see [Specify 7 | Specify Collections Consortium](https://www.specifysoftware.org/products/specify-7/), or email [[email protected]](mailto:[email protected]).
6161
```
6262

63-
9. Add the bullet list of changes you transformed using regex earlier into the newly created document from Step 4.
63+
7. Add the bullet list of changes you transformed using regex earlier into the newly created document from Step 4.
6464

6565
```md
6666
## [7.10.2](https://github.com/specify/specify7/compare/v7.10.1...v7.10.2) (15 April 2025)
@@ -108,7 +108,7 @@ These release notes are always packaged in [Markdown format](https://www.markdow
108108
For more information about Specify 7, or about this release, see [Specify 7 | Specify Collections Consortium](https://www.specifysoftware.org/products/specify-7/), or email [[email protected]](mailto:[email protected]).
109109
```
110110

111-
10. Update the version number. The example below is accurate for the `v7.10.2` release:
111+
8. Update the version number. The example below is accurate for the `v7.10.2` release:
112112

113113
```md
114114
## [7.10.2](https://github.com/specify/specify7/compare/v7.10.1...v7.10.2) (15 April 2025)
@@ -118,7 +118,7 @@ These release notes are always packaged in [Markdown format](https://www.markdow
118118

119119
The comparison URL enables users to click on the version and compare all the changes between it and the previous version.
120120

121-
11. Open each PR link in your browser (`Ctrl`+click on each link in a Markdown/GitHub preview) and begin renaming and moving each change under the appropriate subheading.
121+
9. Open each PR link in your browser (`Ctrl`+click on each link in a Markdown/GitHub preview) and begin renaming and moving each change under the appropriate subheading.
122122

123123
There are three subheading categories:
124124
1. **Added**: Newly added capabilities.
@@ -127,7 +127,11 @@ These release notes are always packaged in [Markdown format](https://www.markdow
127127

128128
As you visit each link and rename these items, move them under the appropriate heading. Order the items within each heading in descending order of importance so users see the most critical changes first.
129129

130-
Instead of saying:
130+
If there are changes that are **completely** internal, these can be ignored and removed from the list, but please ask another staff member if you are unsure.
131+
132+
Each should be written in present tense (e.g. `Fixes` or `Adds`).
133+
134+
When renaming each change, instead of saying:
131135

132136
* Add "default" initialize property to QCBX ([#6037]([https://github.com/specify/specify7/pull/6037]))
133137

@@ -141,4 +145,66 @@ These release notes are always packaged in [Markdown format](https://www.markdow
141145

142146
For clarity, if there are two requesting institutions, separate them by adding `and` between them.
143147

144-
For three or more requesting institutions, use commas before using an and. Oxford comma is needed for Theresa's approval.
148+
For three or more requesting institutions, use commas before using an and. Oxford comma is needed for Theresa's approval.
149+
150+
11. Make sure **all** relevant and necessary documentation is written. Once complete, gather the links to this documentation and integrate them via direct links into the release notes.
151+
152+
153+
12. Create the [Discourse (Community Forum)](https://discourse.specifysoftware.org/) post for the release. You can use the last release update as a reference, but it should look like this (in Markdown syntax). You can copy this as a starting point.
154+
155+
**If there are special notes**, make sure to include those before the "Release Announcement" primary header.
156+
157+
158+
```md
159+
![SpecifyCollectionsConsortium|317x81](upload://oh6shBgn9SAEocJvjf63LyKXJRC)
160+
161+
# Release Announcement
162+
163+
## [7.10.2](https://github.com/specify/specify7/compare/v7.10.1...v7.10.2) (15 April 2025)
164+
165+
166+
## Added
167+
* **Batch Edit**: Support for editing basic fields ([#5417](https://github.com/specify/specify7/pull/5417))
168+
* Added a 'Download' button to record set and query results attachments ([#6052](https://github.com/specify/specify7/pull/6052) – *Requested by The University of Michigan, Naturhistorisches Museum Bern, Beaty Biodiversity Museum, Agriculture and Agri-Food Canada, Muséum d'Histoire Naturelle Geneva, and Queensland Herbarium*)
169+
* The [Form Meta menu](https://discourse.specifysoftware.org/t/form-meta-menu/844) is now accessible when using "View in Forms" ([#5416](https://github.com/specify/specify7/pull/5416))
170+
* A default value can now be used for a query combo box ([#6037]([https://github.com/specify/specify7/pull/6037]) – *Requested by South African Institute for Aquatic Biodiversity and The Ohio State University Mollusk Division*)
171+
* Adds tooltip for required fields in bulk carry forward config ([#6202](https://github.com/specify/specify7/pull/6202))
172+
* Specify will use the default `TypeSearches` when a custom one is not defined for a table ([#6236](https://github.com/specify/specify7/pull/6236))
173+
* Adds a new `uniqueIdentifier` field to Storage ([#6249](https://github.com/specify/specify7/pull/6249))
174+
175+
## Changed
176+
* Non-default Taxon trees can be deleted if they are not used ([#6186](https://github.com/specify/specify7/pull/6186))
177+
* Adds modern attachment placeholder icons for video, audio, text, and other attachment filetypes ([#6119](https://github.com/specify/specify7/pull/6119))
178+
179+
180+
181+
## Fixed
182+
* Fixes an issue that caused some WorkBench data sets. ([#6322](https://github.com/specify/specify7/pull/6322))
183+
* Field formats in the Schema Config utility are selected automatically again ([#6255](https://github.com/specify/specify7/pull/6255))
184+
* Primary Collection Objects (COs) in a consolidated Collection Object Group (COG) can no longer be deleted unless another CO is marked as primary ([#6181](https://github.com/specify/specify7/pull/6181))
185+
* Fixes all cases where table aggregation separators were missing ([#6115](https://github.com/specify/specify7/pull/6115))
186+
* Fixes all cases where taxon tree structure is invalid due to accepted names not being designated as accepted ([#5366](https://github.com/specify/specify7/pull/5366))
187+
* Fixes all cases where coordinate text fields are empty but decimal coordinate fields contain values ([#5368](https://github.com/specify/specify7/pull/5368) – *Reported by The University of Michigan, College of Idaho, and several others*)
188+
* Fixes an issue where the Data Entry screen does not appear in the 'Geology' discipline ([#6365](https://github.com/specify/specify7/pull/6365))
189+
* Fixes an issue where unsaved changes would be lost when toggling the "Use Localized Field Labels" setting in the Form Meta menu
190+
191+
---
192+
193+
The full changelog is available on [GitHub](https://github.com/specify/specify7/blob/production/CHANGELOG.md)
194+
195+
For source code go to the [GitHub Specify 7 repository](http://github.com/specify/specify7/)
196+
197+
For more information about Specify 7, or about this release, see [Specify 7 | Specify Collections Consortium](https://www.specifysoftware.org/products/specify-7/), or email [[email protected]](mailto:[email protected]).
198+
```
199+
200+
12. Verify that all links work appropriately and update the `CHANGELOG.md` file in the branch you are publishing a release for.
201+
202+
![Add to the changelog](changelog_add.png)
203+
204+
Verify the change looks good and commit the changes!
205+
206+
13. Once global testing and all other necessary work has been completed, link to the forum post in the description of the release:
207+
208+
![Create the release](package_release.png)
209+
210+
🎉

0 commit comments

Comments
 (0)