Merged
Conversation
e09dca9 to
fb9c83a
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s documentation and release pipeline by generating man pages during go generate/CI, simplifying create-command cleanup behavior, and removing outdated manual test instructions from contributor docs.
Changes:
- Generate Markdown docs and man pages, then package man pages into a tarball under
.build/. - Deduplicate
createcommand cleanup logic via a single deferred cleanup block. - Update CI/release workflow and ignore rules to include
.build/artifacts.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs.go |
Generates Markdown + man pages and archives man pages into .build/*.tar. |
cmd/create.go |
Consolidates failure cleanup logic using a success flag + deferred function. |
CONTRIBUTING.md |
Removes “Create Database” manual test section. |
.gitignore |
Ignores .build/ output directory. |
.github/workflows/build.yml |
Creates .build/ earlier and publishes .build/* artifacts from releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change introduce generation of man pages in keydex and puts them in a
.tararchive next to the binaries.There will be followup work on https://github.com/shikaan/sup to install the manpages along with the bin.
Closes #33
TODO