crystal docs
: use shard.yml
version when no git tag present
#11232
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.
When generating project documentation with
crystal docs
, the project version may be inferred from either the latest git tag or theversion
key inshard.yml
. However, the version inshard.yml
will only be used if the project is not a git repository. This requirement is counter-intuitive, and means that a project created withwon't generate documentation out of the box without explicitly specifying
--project-version
:This PR allows the version in
shard.yml
to be used regardless of whether or not a project is contained in a git repository; the latest git tag will still be used (if present), so I think this preserves the intention of the original implementation, while also improving the out-of-the-box DX for new projects.