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

Add git commit hash to CLI help & error output #1094

Closed
5 tasks
hu55a1n1 opened this issue Jun 16, 2021 · 0 comments · Fixed by #1101
Closed
5 tasks

Add git commit hash to CLI help & error output #1094

hu55a1n1 opened this issue Jun 16, 2021 · 0 comments · Fixed by #1101
Assignees
Labels
I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product
Milestone

Comments

@hu55a1n1
Copy link
Member

Crate

ibc-relayer-cli

Summary

Print the git commit hash in the description. This makes it easier to identify the exact source that was used to create the CLI binary.

Proposal

Either we print a valid semver that contains the short/long commit hash, e.g. 1.2.3-unstable+develop.a68295 or 1.1.2+a682956dccae752aa24597a0f5cd939f93614509 ->

$ hermes
hermes 0.4.0-unstable+feature-branch.a68295
Informal Systems <hello@informal.systems>
Hermes is an IBC Relayer written in Rust.

# ...

Or, we print the commit hash as part of the description ->

$ hermes
hermes 0.4.0
Informal Systems <hello@informal.systems>
v0.4.0 [a682956dccae752aa24597a0f5cd939f93614509] built on 2021-06-16T21:30:10
Hermes is an IBC Relayer written in Rust.

# ...

Acceptance Criteria

The git commit hash must appear in the usage, help (including subcommand helps), version and error outputs.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@hu55a1n1 hu55a1n1 self-assigned this Jun 16, 2021
@hu55a1n1 hu55a1n1 mentioned this issue Jun 17, 2021
5 tasks
@adizere adizere added this to the 07.2021 milestone Jun 24, 2021
@adizere adizere added I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product labels Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants