Skip to content
Snippets Groups Projects
Commit e41fc00f authored by James Alexander Clark PhD's avatar James Alexander Clark PhD
Browse files

minor addition to release instructions

parent 1376032c
No related branches found
No related tags found
No related merge requests found
# Preparing A Release
Please familiarise yourself with this entire procedure before starting.
Procedure:
1. [Update Documentation](#update-documentation)
1. [Create a tag](#create-a-tag)
1. [Build A Release Tarball](#build-a-release-tarball)
1. [upload Source Tarball](#upload-source-tarball)
1. [Open SCCB Request](#open-sccb-request)
1. [Deployment](#deployment)
## Update Documentation
Along with any changes describing new functionality, the documentation should
be updated to show the version number (see next step). This should be done
first, so that the documentation matches the release. Specifically, edit `conf.py`
[here](https://git.ligo.org/lscsoft/bayeswave/blob/master/doc/conf.py#L25).
Future releases may automate this step.
## Create a tag
Tag the state of the repository you'd like to release: [create new tag in
gitlab](https://git.ligo.org/lscsoft/bayeswave/-/tags/new). See [previous
......@@ -40,7 +49,7 @@ On success, this should produce a compressed tarball `bayeswave-X.Y.Z.tar.xz`,
where `X.Y.Z` is your tag version.
## Upload Source Tarball
Acquire the upload script `lscsrc_new_file.sh` from Adam Mercer. If using
Acquire the upload script `lscsrc_new_file.sh` from UWM. If using
linux (rather than OSX), make sure you change the call to `gmktemp` to `mktemp`:
```
#SKTFILE=`gmktemp --dry-run`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment