Skip to content
This repository was archived by the owner on Jan 27, 2020. It is now read-only.

Commit f00f8c9

Browse files
committed
add documentation about making release
1 parent eb2ff45 commit f00f8c9

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

.github/RELEASE_CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release checklist
22

3-
This checklist is for our own reference
3+
> This checklist is for our own reference, to help us prepare a new release
44
55
1. Check that everything is ready to go
66

docs/RELEASE.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# RELEASE
2+
3+
> This document is for helping Sarek core developers and anyone joining the team to prepare a new release
4+
5+
## [CHECKLIST](https://github.com/SciLifeLab/Sarek/blob/master/.github/RELEASE_CHECKLIST.md)
6+
7+
This checklist is for our own reference, to help us prepare a new release.
8+
Just follow it and be sure to check every item on the list.
9+
10+
## [Helper script](https://github.com/SciLifeLab/Sarek/blob/master/scripts/do_release.sh)
11+
12+
This script will update the version number in the following files:
13+
14+
- [CHANGELOG.md](https://github.com/SciLifeLab/Sarek/blob/master/CHANGELOG.md)
15+
- Will change Unreleased to correct version number and add codename and date
16+
- [Dockerfile](https://github.com/SciLifeLab/Sarek/blob/master/Dockerfile)
17+
- Will update to correct version number
18+
- [Singularity](https://github.com/SciLifeLab/Sarek/blob/master/Singularity)
19+
- Will update to correct version number
20+
- [conf/base.config](https://github.com/SciLifeLab/Sarek/blob/master/conf/base.config)
21+
- Will update to correct version number
22+
23+
### Usage
24+
25+
### Usage
26+
27+
```bash
28+
./scripts/do_release.sh -r "<RELEASE>" -c "<CODENAME>"
29+
```
30+
31+
- `-r|--release` specify the new version number
32+
- `-c|--codename` specify the codename
33+
34+
### Example
35+
36+
```bash
37+
./scripts/do_release.sh -r "2.2.0" -c "Skårki"
38+
```

0 commit comments

Comments
 (0)