Release v0.1.1 (informalsystems#681)

* Preparing for release v0.1.1 - Added binary release workflow. - Bumped version. - Upd changelog. * Added lock file. Removed changelog from release workflow * Specified archive format. Removed windows * Added zip back. Added archive comment * Removed workspace .lock file from .gitignore * Updated GH release template to mention lock file * Added the binary name explicitly in relayer-cli manifest
hu55a1n1 · Feb 18, 2021 · c8ad8c7 · c8ad8c7
1 parent 5afd194
commit c8ad8c7
Show file tree

Hide file tree

Showing 10 changed files with 3,131 additions and 34 deletions.
diff --git a/.github/ISSUE_TEMPLATE/release-template.md b/.github/ISSUE_TEMPLATE/release-template.md
@@ -17,4 +17,5 @@ v                     without deliberation
 
 - [ ] Create new release section in [CHANGELOG](./CHANGELOG.md) and move "unreleased" items into this section.
 - [ ] Bump all crate versions to the new version.
-- [ ] Reassign unfinished issues of previous milestone to the next milestone.
+- [ ] Reassign unfinished issues of previous milestone to the next milestone.
+- [ ] Update Cargo.lock file (if re-publishing `ibc-relayer-cli`)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,54 @@
+# Uploads Hermes binary.
+# Ref: https://github.com/marketplace/actions/build-and-upload-rust-binary-to-github-releases
+
+name: Release
+
+on:
+  push:
+    tags:
+      - v[0-9]+.*
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: taiki-e/create-gh-release-action@v1
+        env:
+          # (required)
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-assets:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: taiki-e/upload-rust-binary-action@v1
+        with:
+          # (required)
+          bin: hermes
+          # (optional) On which platform to distribute the `.tar.gz` file.
+          # [default value: unix]
+          # [possible values: all, unix, windows, none]
+          tar: unix
+          # (optional) On which platform to distribute the `.zip` file.
+          # [default value: windows]
+          # [possible values: all, unix, windows, none]
+          zip: unix
+          # (optional) Archive name (non-extension portion of filename) to be uploaded.
+          # [default value: $bin-$target]
+          # [possible values: the following variables and any string]
+          #   variables:
+          #     - $bin - Binary name (non-extension portion of filename).
+          #     - $target - Target triple.
+          #     - $tag - Tag of this release.
+          archive: $bin-$tag-$target
+        env:
+          # (required)
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # (optional)
+          CARGO_PROFILE_RELEASE_LTO: true
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,7 @@
-
-
 # Generated by Cargo
 # will have compiled files and executables
 /target/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
 # These are backup files generated by rustfmt
 **/*.rs.bk
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,28 +1,87 @@
 # Changelog
 
-## Unreleased Changes
+[comment]: <> (## Unreleased Changes)
 
-> [high level summary]
+[comment]: <> (> [high level summary])
 
-### FEATURES
+[comment]: <> (### FEATURES)
 
-- [ibc]
-  - [nothing yet]
+[comment]: <> (- [ibc])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer-cli])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (### IMPROVEMENTS)
+
+[comment]: <> (- [ibc])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer-cli])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (### BUG FIXES)
+
+[comment]: <> (- [ibc])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer-cli])
 
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (### BREAKING CHANGES)
+
+[comment]: <> (- [ibc])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer])
+
+[comment]: <> (  - [nothing yet])
+
+[comment]: <> (- [ibc-relayer-cli])
+
+[comment]: <> (  - [nothing yet])
+
+## v0.1.1
+*February 17, 2021*
+
+This release brings a quick fix for a problem with a dependency of crate
+`ibc-relayer`, which causes build & installation issues. Many thanks to 
+@Fraccaman for bringing this problem to our attention! ([#672])
+
+
+Additionally, this release also introduces initial implementation for most of
+ICS 004 handlers, and several bug fixes and improvements, e.g., refactored
+some CLI code, refactored the Height type in the IBC Events, and a bug fix
+involving packet acks in a 3-chain setup. More details below. 
+
+### FEATURES
 - [ibc-relayer]
   - Listen to channel close initialization event and perform the close handshake ([#560])
 
-- [ibc-relayer-cli]
-  - [nothing yet]
-
 ### IMPROVEMENTS
 
 - [ibc]
   - Change event height to ICS height ([#549])
 
-- [ibc-relayer]
-  - [nothing yet]
-
 - [ibc-relayer-cli]
   - Cleanup CLI code ([#572])
 
@@ -44,9 +103,6 @@
   - Implementation of the `ChanOpenAck`, `ChanOpenConfirm`, `ChanCloseInit`, and `ChanCloseConfirm` handlers ([#316])
   - Remove dependency on `tendermint-rpc` ([#624])
 
-- [ibc-relayer]
-  - [nothing yet]
-
 - [ibc-relayer-cli]
   - Remove the `proof` option from CLI ([#572])
 
@@ -59,6 +115,7 @@
 [#626]: https://github.com/informalsystems/ibc-rs/issues/626
 [#643]: https://github.com/informalsystems/ibc-rs/issues/643
 [#665]: https://github.com/informalsystems/ibc-rs/issues/665
+[#672]: https://github.com/informalsystems/ibc-rs/issues/672
 
 ## v0.1.0
 *February 4, 2021*