Commit 5c147bac authored by William Clarke's avatar William Clarke
Browse files

Update changelog and release isntructions.

parent d9c05d06
Pipeline #11195 passed with stages
in 13 minutes and 6 seconds
This document contains the FSL-MRS release history in reverse chronological order.
1.1.9 (WIP)
-------------------------------
- Fixed typos in fsl_mrs_proc help.
- Fixed simulator bug for edited sequence coherence filters.
1.1.8 (Tuesday 5th October 2021)
-------------------------------
- Fix bug in fsl_mrsi when default MM are added to a incorrectly conjugated basis set.
......
Instructions for releasing a new version of FSL-MRS
===================================================
1. All tests passing
2. Identify new version number
3. Update CHANGELOG.rst
4. Commit to development fork master branch (e.g. wclarke/fsl_mrs:master)
5. Initiate merge request, and merge into fsl/fsl_mrs:master
6. Create new tag -tag name should be "x.x.x" with the message "Vx.x.x". New changelog contents are copied into release notes.
7. This will trigger doc build (published [here](https://open.win.ox.ac.uk/pages/fsl/fsl_mrs/)) and package build (currently broken).
8. Pull upstream master into development fork (with tags). See help [here](https://www.atlassian.com/git/tutorials/git-forks-and-upstreams).
```git fetch upstream --tags```
```git checkout master```
```git merge upstream/master```
1. Establish feature branch in local copy of fork.
```git fetch upstream```
```git checkout -b feature upstream/master```
2. Make changes.
3. Update CHANGELOG.rst (establish new entry and version number if needed).
4. Commit and push feature branch to remote
5. Check all tests pass.
6. Merge to fsl/fsl_mrs:master.
7. Repeat with other features.
8. For new version create new tag -tag name should be "x.x.x" with the message "Vx.x.x". New changelog contents are copied into release notes.
9. This will trigger doc build (published [here](https://open.win.ox.ac.uk/pages/fsl/fsl_mrs/)) and package build (currently broken).
10. Update local master.
```git fetch upstream --tags```
```git checkout master```
```git merge upstream/master```
```git push origin --tags```
9. Trigger manual package build using the [fsl/conda/fsl-mrs:pre-conda](https://git.fmrib.ox.ac.uk/fsl/conda/fsl-mrs:pre-conda) branch. Do this by updating the version number [here](https://git.fmrib.ox.ac.uk/fsl/conda/fsl-mrs/-/blob/mnt/pre-conda/meta.yaml#L6). This will trigger a pipeline from which the conda package can be downloaded (*Download build-noarch-conda-package:archive artifact*).
10. Send to MW for manual upload to the FSL conda channel.
\ No newline at end of file
11. Trigger manual package build using the [fsl/conda/fsl-mrs:pre-conda](https://git.fmrib.ox.ac.uk/fsl/conda/fsl-mrs:pre-conda) branch. Do this by updating the version number [here](https://git.fmrib.ox.ac.uk/fsl/conda/fsl-mrs/-/blob/mnt/pre-conda/meta.yaml#L6). This will trigger a pipeline from which the conda package can be downloaded (*Download build-noarch-conda-package:archive artifact*).
12. Send to MW for manual upload to the FSL conda channel.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment