Skip to content

Commit 899b901

Browse files
committed
📝 Update RELEASE.md with instructions on how to use upload-release.sh
1 parent 6ef546b commit 899b901

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

RELEASE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
## Release Instructions
22

3-
1. Make sure, that all tests are successful:
3+
1. Make sure that all tests are successful:
44
```bash
55
$ ./gradlew test
66
```
77
2. Also test the package in the GUI by doing the test cases outlined in [GUI-TEST.md](./GUI-TEST.md)
88

9-
3. Increase the version and tag the release with the new version. The `version-bump.sh <old-version-tag> <new-version-tag>` script might be helpful.
9+
3. Increase the version and tag the release with the new version. This can be done with `version-bump.sh`:
10+
```bash
11+
$ ./version-bump.sh 1.7.0 1.7.1
12+
```
1013

1114
4. Add a blurb of changes to the `Changes` section in `Description.props`
1215

@@ -16,4 +19,7 @@ $ ./make-release-files.sh
1619
```
1720
6. [Draft a new GitHub release](https://github.com/Waikato/wekaDeeplearning4j/releases/new), add a changelog and the sha256 sums that were generated during (4) in `release-files/sums.sha256`
1821

19-
7. Upload all ZIP files and sh/ps1 scripts in the `release-files` directory generated in step (3).
22+
7. Upload all ZIP files and sh/ps1 scripts in the `release-files` directory generated in step (3). This can be done with the `upload-release.sh` script:
23+
```bash
24+
$ ./upload-release.sh 1.7.1
25+
```

upload-release.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
if [ -z "$1" ]
44
then
5-
echo "No release tag supplied - please supply as argument, e.g., ./upload-release v1.7.1"
5+
echo "No release tag supplied - please supply as argument, e.g., ./upload-release 1.7.1"
66
exit 1
77
fi
88

9-
TAG="$1"
9+
TAG="v$1"
1010
# clobber overwrites existing assets of the same name
1111
BASE_COMMAND="gh release upload ${TAG} --clobber"
1212

version-bump.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
#!/usr/bin/env bash
22

3+
if [[ $# -ne 2 ]]; then
4+
echo "Illegal number of parameters. Usage: ./version-bump.sh <old tag number> <new tag number>"
5+
echo "e.g.: ./version-bump.sh 1.7.0 1.7.1"
6+
fi
7+
38
old=$1
49
new=$2
510

0 commit comments

Comments
 (0)