Skip to content

Commit 326335c

Browse files
author
Stefan Hahmann
committed
Add release.md with information re release process to doc folder
1 parent 30f01e9 commit 326335c

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

doc/release.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Release
2+
3+
* [ ] Merge Open Pull Requests
4+
* [ ] Documentation
5+
- [ ] Update Documentation in the repo
6+
- [ ] Update Documentation on readthedocs
7+
- [ ] Screenshots with demo data
8+
- [ ] Screencasts
9+
- [ ] Point to example data (e.g. celltrackingchallenge, Kos data from Elephant paper)
10+
* [ ] Check out the latest master branch
11+
* [ ] Update license information
12+
* [ ] Open command line and navigate to the project root directory
13+
* [ ] Run "mvn license:update-file-header" and commit
14+
* [ ] Update release date and version in CITATION.cff file and commit
15+
* [ ] Run release Script (de-snapshots, sets a tag and sets the next snapshot version, generates javadoc, runs unit
16+
tests)
17+
* [x] Check, if github action is installed, which copies the release to maven.scijava.org
18+
* [ ] For reference: Release script https://github.com/scijava/scijava-scripts/blob/main/release-version.sh
19+
* [ ] Clone https://github.com/scijava/scijava-scripts repo
20+
* [ ] Ensure that one of the git remotes has the name "origin"
21+
* [ ] Close IntelliJ, if open
22+
* [ ] Run sh /path/to/release-version.sh from the mastodon-deep-lineage root directory
23+
* [ ] Confirm version number
24+
* [ ] The release script pushes to master on github.com
25+
* This triggers a *github Action* which copies the version to be released to maven.scijava.org.
26+
cf. https://maven.scijava.org/#nexus-search;quick~mastodon-deep-lineage)
27+
* [ ] Download created jar file from scijava Nexus (https://maven.scijava.org/#nexus-search;quick~mastodon-deep-lineage)
28+
* [ ] Delete jar-file from last release version from local Fiji installation path
29+
* [ ] Copy jar file of the new version to local Fiji installation path
30+
* [ ] Test, if Fiji starts successfully
31+
* [ ] Test new functionalities of released version in Fiji
32+
* [ ] Copy Jar-File to Mastodon-DeepLineage Update-Site using Fiji/ImageJ Updaters (Fiji > Help > Update...)
33+
* [ ] Set Updater to Advanced Mode
34+
* [ ] If needed, add `webdav:user_name_for_update_site` as `Host` under
35+
`Manage Update Sites > Mastodon-DeepLineage`
36+
* [ ] Upload mastodon-deep-lineage-release-version.jar
37+
* [ ] Check Upload success: https://sites.imagej.net/Mastodon-DeepLineage/jars/
38+
* [ ] Add Release documentation: https://github.com/mastodon-sc/mastodon-deep-lineage/releases
39+
* [ ] Check Release on Zenodo https://zenodo.org/account/settings/github/repository/mastodon-sc/mastodon-deep-lineage
40+
or https://zenodo.org/doi/10.5281/zenodo.10262664

0 commit comments

Comments
 (0)