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

feat(gnoland): Improve gnoland config/secrets command description #2399

Merged
merged 5 commits into from
Aug 9, 2024

Conversation

gfanton
Copy link
Member

@gfanton gfanton commented Jun 20, 2024

Depends on:

This PR improves the gnoland config get/set and gnoland secrets get commands by adding a description for each subcommand dynamically based on the config tags name and comment.
The first line of the comment will determine the command ShortHelp.
The entire comment will determine the LongHelp.

Demo:

demo

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated
    the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@gfanton gfanton self-assigned this Jun 20, 2024
@github-actions github-actions bot added 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related labels Jun 20, 2024
Copy link

codecov bot commented Jun 20, 2024

Codecov Report

Attention: Patch coverage is 97.53086% with 2 lines in your changes missing coverage. Please review.

Project coverage is 59.98%. Comparing base (1f58ee4) to head (25b3dc3).
Report is 1 commits behind head on master.

Files Patch % Lines
gno.land/cmd/gnoland/config_help.go 96.61% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2399      +/-   ##
==========================================
- Coverage   60.11%   59.98%   -0.14%     
==========================================
  Files         560      561       +1     
  Lines       74911    77412    +2501     
==========================================
+ Hits        45036    46437    +1401     
- Misses      26500    27458     +958     
- Partials     3375     3517     +142     
Flag Coverage Δ
contribs/gnodev 61.40% <ø> (ø)
contribs/gnofaucet 14.46% <ø> (ø)
gno.land 64.76% <97.53%> (+0.58%) ⬆️
gnovm 64.13% <ø> (ø)
misc/genstd 80.54% <ø> (ø)
misc/logos 19.88% <ø> (ø)
tm2 62.04% <ø> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gfanton gfanton changed the title feat(gnoland): Improve gnoland command description feat(gnoland): Improve gnoland config/secrets command description Jun 20, 2024
@zivkovicmilos
Copy link
Member

@moul @thehowl this is too cool

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>
Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>
Copy link
Member

@zivkovicmilos zivkovicmilos left a comment

Choose a reason for hiding this comment

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

Amazing 👏

gno.land/cmd/gnoland/config_get.go Show resolved Hide resolved
gno.land/cmd/gnoland/config_help.go Outdated Show resolved Hide resolved
Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>
Copy link
Contributor

@leohhhn leohhhn left a comment

Choose a reason for hiding this comment

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

Nice, looks cool!

@gfanton gfanton merged commit 36c8b03 into gnolang:master Aug 9, 2024
115 checks passed
@gfanton gfanton deleted the feat/gnoland-config-help branch August 9, 2024 13:22
MikaelVallenet pushed a commit to MikaelVallenet/gno that referenced this pull request Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants