Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release Hermes v1.0.0 #2577

Merged
merged 9 commits into from
Aug 22, 2022
Merged

Release Hermes v1.0.0 #2577

merged 9 commits into from
Aug 22, 2022

Conversation

romac
Copy link
Member

@romac romac commented Aug 18, 2022

Closes: #2406

@romac romac marked this pull request as ready for review August 19, 2022 12:29
@romac romac requested review from adizere and seanchen1991 August 19, 2022 13:58
Copy link
Contributor

@seanchen1991 seanchen1991 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused by why the contents of .changelog/v1.0.0/summary.md are duplicated in CHANGELOG.md. Is this intentional? It's a bit awkward then that my suggestions made in summary.md need to be duplicated in CHANGELOG.md (though I guess you could just copy-paste the changes over once they've all been addressed).


> ⚠️ If upgrading from Hermes v0.15.0, be aware that this release contains multiple breaking
> ⚠️ changes to the Hermes command-line interface and configuration.
> ⚠️ Please consult the [UPGRADING document for instructions](UPGRADING.md) ) for a more detadetails.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> ⚠️ Please consult the [UPGRADING document for instructions](UPGRADING.md) ) for a more detadetails.
> ⚠️ Please consult the [UPGRADING document for instructions](UPGRADING.md) for more details.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think changelog.md is a compilation of all the files in .changelog/v1.., including the summary. See https://github.com/informalsystems/unclog.

(BTW I think it might be useful if you get a bit more familiar with the release process Sean in case this is of interest to you. I think we have a recording somewhere of Romain and Shoaib doing a release.)

The flag to specify the key name for the CLI command `keys add` has been changed
from `-n` to `-k`. Restoring a key now takes a file containing the mnemonic as
input instead of directly taking the mnemonic
- Deprecated `gas_adjustment` setting in favor of new `gas_multiplier` setting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it clear to users / readers of this changelog where to find more information on the new gas_multiplier setting? If not, can we add a brief description here of how it's different from gas_adjustment?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! 6cb5a91

.changelog/v1.0.0/summary.md Outdated Show resolved Hide resolved
.changelog/v1.0.0/summary.md Outdated Show resolved Hide resolved
.changelog/v1.0.0/summary.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
UPGRADING.md Outdated Show resolved Hide resolved
## v1.0.0
*August 22nd, 2022*

After more than 2 years in the works, this is the first stable release of the Hermes relayer! 🎉
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After more than 2 years in the works, this is the first stable release of the Hermes relayer! 🎉
After more than 2 years in the works, this is the first stable release of the Hermes relayer! 🎉
For reaching this milestone, we thank the valuable contributions of over 50 individuals, spread across more than 800 documented & resolved issues. Beside Cosmos-SDK and Tendermint, we are fortunate to maintain some of the most active and intense repository in the Cosmos ecosystem. Most importantly, we thank the relentless work of relayer operators that have already relayed billions worth of value in IBC production networks, and have provided us with invaluable feedback on improving Hermes and raising the overall stability of IBC. Kudos to everyone!

Copy link
Member Author

@romac romac Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a CONTRIBUTORS.md document to the repo which documents everybody who's contributed to the repo?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the highlight Adi 🙏

for Hermes v1.0.0.

The structure of this changelog has therefore changed as well,
changes are now grouped first by crate and then by the type of change,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes a lot of sense!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that we should add support for this format to unclog

Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

romac and others added 3 commits August 22, 2022 11:33
Thanks @seanchen1991 and @adizere!

Co-authored-by: Sean Chen <seanchen11235@gmail.com>
Co-authored-by: Adi Seredinschi <adi@informal.systems>
@romac romac merged commit 949144e into master Aug 22, 2022
@romac romac deleted the release/v1.0.0 branch August 22, 2022 10:45
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
* Bump relayer-cli crate to v1.0.0 and update guide

* Bump crates to 0.19.0, and protos to 0.20.1

* Update lockfiles

* Release changelog

* Update UPGRADING instructions

* Update lockfile

* Link to upgrading doc for gas_multiplier change

* Apply suggestions fro review

Thanks @seanchen1991 and @adizere!

Co-authored-by: Sean Chen <seanchen11235@gmail.com>
Co-authored-by: Adi Seredinschi <adi@informal.systems>

Co-authored-by: Sean Chen <seanchen11235@gmail.com>
Co-authored-by: Adi Seredinschi <adi@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Release v1.0.0
3 participants