Skip to content

Commit

Permalink
update release template and release template script
Browse files Browse the repository at this point in the history
  • Loading branch information
KtorZ committed Aug 3, 2020
1 parent 6670c27 commit 082127d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 33 deletions.
36 changes: 6 additions & 30 deletions .github/RELEASE_TEMPLATE.md
Expand Up @@ -20,20 +20,19 @@ Compatible with [`jormungandr@{{JORM_TAG}}`](https://github.com/input-output-hk/

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

| Link | Audience |
| --- | --- |
| [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/{{GIT_TAG}}) | Users of the Cardano Wallet API |
| 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 |
| [Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker/{{DOCKER_WIKI_COMMIT}}) | Users of the Cardano Wallet API |
| [Haddock Documentation](https://input-output-hk.github.io/cardano-wallet/haddock/{{GIT_TAG}}) | Haskell Developers using the `cardano-wallet` as a library |
Cardano (cardano-node) | ITN (Jörmungandr)
--- | ---
[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}})
[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}})
[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}})

## Installation Instructions

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

### Shelley testnet (cardano-node)
### Cardano (cardano-node)

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

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

### Byron (cardano-node)

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

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.

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}})

4. Start `cardano-wallet --help` and see available parameters.

#### Docker

Pull from DockerHub and verify the version matches {{CABAL_VERSION}}.

```
$ docker pull inputoutput/cardano-wallet:{{CABAL_VERSION}}-byron
$ docker run --rm inputoutput/cardano-wallet:{{CABAL_VERSION}}-byron version
```

### Additional notes

- On macOS: Make sure all `*.dylib` files are in the same directory as `cardano-wallet` binary.

## Signatures

<!-- Signatures of people responsible for the release -->
Expand Down
4 changes: 1 addition & 3 deletions scripts/make_release.sh
Expand Up @@ -48,9 +48,7 @@ sed -e "s/{{GIT_TAG}}/$GIT_TAG/g" \
-e "s/{{JORM_TAG}}/$JORM_TAG/g" \
-e "s/{{CARDANO_NODE_TAG}}/$CARDANO_NODE_TAG/g" \
-e "s/{{CABAL_VERSION}}/$CABAL_VERSION/g" \
-e "s/{{DOCKER_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
-e "s/{{JORM_CLI_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
-e "s/{{BYRON_CLI_WIKI_COMMIT}}/$WIKI_COMMIT/g" \
-e "s/{{WIKI_COMMIT}}/$WIKI_COMMIT/g" \
-e "/{{CHANGELOG}}/r $CHANGELOG" \
-e "/{{CHANGELOG}}/d" \
.github/RELEASE_TEMPLATE.md > $OUT
Expand Down

0 comments on commit 082127d

Please sign in to comment.