Skip to content

Commit 082127d

Browse files
committed
update release template and release template script
1 parent 6670c27 commit 082127d

File tree

2 files changed

+7
-33
lines changed

2 files changed

+7
-33
lines changed

.github/RELEASE_TEMPLATE.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,19 @@ Compatible with [`jormungandr@{{JORM_TAG}}`](https://github.com/input-output-hk/
2020

2121
<!-- A snapshot of the documentation at the time of releasing. -->
2222

23-
| Link | Audience |
24-
| --- | --- |
25-
| [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/{{GIT_TAG}}) | Users of the Cardano Wallet API |
26-
| CLI Manual: [ITN](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-Command-Line-Interface/{{JORM_CLI_WIKI_COMMIT}}) / [Byron](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-Command-Line-Interface-(cardano-wallet-byron)/{{BYRON_CLI_WIKI_COMMIT}}) | Users of the Cardano Wallet API |
27-
| [Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker/{{DOCKER_WIKI_COMMIT}}) | Users of the Cardano Wallet API |
28-
| [Haddock Documentation](https://input-output-hk.github.io/cardano-wallet/haddock/{{GIT_TAG}}) | Haskell Developers using the `cardano-wallet` as a library |
23+
Cardano (cardano-node) | ITN (Jörmungandr)
24+
--- | ---
25+
[API Documentation](https://input-output-hk.github.io/cardano-wallet/api/{{GIT_TAG}}) | [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/{{GIT_TAG}})
26+
[CLI Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-command-line-interface/{{WIKI_COMMIT}}) | [CLI Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-command-line-interface-jormungandr/{{WIKI_COMMIT}})
27+
[Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker/{{WIKI_COMMIT}}) | [Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker-jormungandr/{{WIKI_COMMIT}})
2928

3029
## Installation Instructions
3130

3231
<!-- Specific installation steps for this particular release. This should
3332
basically captures whatever is currently available on the repository at
3433
the moment of releasing. -->
3534

36-
### Shelley testnet (cardano-node)
35+
### Cardano (cardano-node)
3736

3837
1. Install [`cardano-node@{{CARDANO_NODE_TAG}}`](https://github.com/input-output-hk/cardano-node/releases/tag/{{CARDANO_NODE_TAG}}).
3938

@@ -69,29 +68,6 @@ $ docker pull inputoutput/cardano-wallet:{{CABAL_VERSION}}-jormungandr
6968
$ docker run --rm inputoutput/cardano-wallet:{{CABAL_VERSION}}-jormungandr version
7069
```
7170

72-
### Byron (cardano-node)
73-
74-
1. Install [`cardano-node@{{CARDANO_NODE_TAG}}`](https://github.com/input-output-hk/cardano-node/releases/tag/{{CARDANO_NODE_TAG}}).
75-
76-
2. Download the provided `cardano-wallet-byron` for your platform, and uncompress it in a directory that is on your `$PATH`, e.g. `/usr/local/bin`. Or `%PATH%` on Windows.
77-
78-
3. (optional) Install the bash/zsh auto-completion script according to the [byron cli manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-Command-Line-Interface-(cardano-wallet-byron)/{{BYRON_CLI_WIKI_COMMIT}})
79-
80-
4. Start `cardano-wallet --help` and see available parameters.
81-
82-
#### Docker
83-
84-
Pull from DockerHub and verify the version matches {{CABAL_VERSION}}.
85-
86-
```
87-
$ docker pull inputoutput/cardano-wallet:{{CABAL_VERSION}}-byron
88-
$ docker run --rm inputoutput/cardano-wallet:{{CABAL_VERSION}}-byron version
89-
```
90-
91-
### Additional notes
92-
93-
- On macOS: Make sure all `*.dylib` files are in the same directory as `cardano-wallet` binary.
94-
9571
## Signatures
9672

9773
<!-- Signatures of people responsible for the release -->

scripts/make_release.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,7 @@ sed -e "s/{{GIT_TAG}}/$GIT_TAG/g" \
4848
-e "s/{{JORM_TAG}}/$JORM_TAG/g" \
4949
-e "s/{{CARDANO_NODE_TAG}}/$CARDANO_NODE_TAG/g" \
5050
-e "s/{{CABAL_VERSION}}/$CABAL_VERSION/g" \
51-
-e "s/{{DOCKER_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
52-
-e "s/{{JORM_CLI_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
53-
-e "s/{{BYRON_CLI_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
51+
-e "s/{{WIKI_COMMIT}}/$WIKI_COMMIT/g" \
5452
-e "/{{CHANGELOG}}/r $CHANGELOG" \
5553
-e "/{{CHANGELOG}}/d" \
5654
.github/RELEASE_TEMPLATE.md > $OUT

0 commit comments

Comments
 (0)