Skip to content

Commit

Permalink
📝 Update RELEASE.md with instructions on how to use upload-release.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
basedrhys committed Dec 8, 2020
1 parent 6ef546b commit 899b901
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
12 changes: 9 additions & 3 deletions RELEASE.md
@@ -1,12 +1,15 @@
## Release Instructions

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

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.
3. Increase the version and tag the release with the new version. This can be done with `version-bump.sh`:
```bash
$ ./version-bump.sh 1.7.0 1.7.1
```

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

Expand All @@ -16,4 +19,7 @@ $ ./make-release-files.sh
```
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`

7. Upload all ZIP files and sh/ps1 scripts in the `release-files` directory generated in step (3).
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:
```bash
$ ./upload-release.sh 1.7.1
```
4 changes: 2 additions & 2 deletions upload-release.sh
Expand Up @@ -2,11 +2,11 @@

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

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

Expand Down
5 changes: 5 additions & 0 deletions version-bump.sh
@@ -1,5 +1,10 @@
#!/usr/bin/env bash

if [[ $# -ne 2 ]]; then
echo "Illegal number of parameters. Usage: ./version-bump.sh <old tag number> <new tag number>"
echo "e.g.: ./version-bump.sh 1.7.0 1.7.1"
fi

old=$1
new=$2

Expand Down

0 comments on commit 899b901

Please sign in to comment.