Add '--man-version', '--man-date' parameters #40
Conversation
This file contains 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
It's easier to test from here and avoids us having loads of code in a dunder file. Some style fixups are included. Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Stephen Finucane <[email protected]>
Provide a way to override the date and version used in generated man pages. This can be useful where you want to generate man pages before actually releasing something and don't want to manually edit them. Signed-off-by: Stephen Finucane <[email protected]>
The tests now rely on the package being installed. Do that by using tox to run our tests in Travis, like we do locally. Signed-off-by: Stephen Finucane <[email protected]>
stephenfin
force-pushed
the
reproducible-build
branch
from
16fca32
to
2b2c1b1
Compare
|
Rebased. Is anyone interested in this? I can abandon if not. |
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.
I store generated man pages in git. While auto-generated files generally aren't stored in version control, there are some advantages to this, chief among them being ease of packaging. Unfortunately, for projects that use something like
setuptools-scm, there doesn't currently appear to be an easy way to generate these man pages ahead of time since the version information is retrieved from thedist.versionattribute of the given command'sEntryPoint. This means your generated man pages have versions like1.2.3.dev4when we want1.2.4.The solution is easy. Add a
--man-versionparameter (so named because--versionis already taken), allowing you to configure this manually. For completeness, we also add a--man-dateparameter, allowing you to configure the other dynamic property of these man pages. There are four steps necessary to achieve this:click_man.shell, so it can be tested.Resolves: #38