Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1311 +/- ##
==========================================
+ Coverage 72.43% 72.56% +0.12%
==========================================
Files 301 300 -1
Lines 11005 10986 -19
==========================================
Hits 7972 7972
+ Misses 2144 2125 -19
Partials 889 889
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Some considerations:
|
5f9b15c to
be4a77e
Compare
|
The manpage output (as well as the generated markdown docs) would have a way better table view if the tables are printed using markdown format. Our table renderer already supports this, we just need to find a way to switch between the pretty print and markdown. I used a custom config option for now but it doesn't seem to work, because viper is not loaded if you only generate docs/manpages. I'll have a look at this another time. |
scripts/manpages.go
Outdated
| "github.com/hetznercloud/cli/internal/version" | ||
| ) | ||
|
|
||
| const directory = "./manpages" |
There was a problem hiding this comment.
What do you think about running this and completions.sh as part of go generate and dump the generated files in dist/{manpages,completions}?
Related to the above, is there a reason to put these two files and internal/scripts/generate_docs.go in separate places? They feel pretty related.
There was a problem hiding this comment.
Yes, it could use some clean up, I'll do that
There was a problem hiding this comment.
Two things:
- Goreleaser requires
dist/to be empty, even after the before hooks. So we probably can't (easily) put our generated files there - Why do we want to
go generatethe manpages and completions? We don't want to commit them into the repository and they are only needed for a release anyway. Only generating manpages and completions is pretty fast, but running a fullgo generatebefore each release would be slow.
b47f89d to
305377e
Compare
305377e to
d4b548c
Compare
apricote
left a comment
There was a problem hiding this comment.
Looking good in general. Please document the new release artifacts for users. Should we mark them as experimental at first?

This PR adds the following package files to releases:
hcloud-cli-1.59.0-1.aarch64.rpmhcloud-cli-1.59.0-1.x86_64.rpmhcloud-cli_1.59.0_amd64.debhcloud-cli_1.59.0_arm64.deb