docs: fix incorrect version in documentation #586
Merged
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
github-actions
bot
added
the
documentation
tigarmo
force-pushed
the
work/CRAFT-3018-fix-docs-version
branch
from
29a326d to
1ef4b6d
Compare
Readthedocs builds don't fetch tags when cloning the repo. This is a problem for us because Rockcraft's version comes from the tag (via setuptools-scm), so do a fetch of the tags as a post-checkout step.
The bug is this: If a build is done off of (say) 'main', the version coming from 'git describe' will be something like 1.32.2.postXXXX. We previously dropped the ".post*" suffix because it confused the spellchecker but that just leaves the misleading "1.32.2" string. It's misleading because that's an actual released version that does *not* contain a lot of the content in 'main'. So just use "dev" instead, to make it extra explicit that the docs refer to an unreleased version of the software.
tigarmo
force-pushed
the
work/CRAFT-3018-fix-docs-version
branch
from
1ef4b6d to
cab5176
Compare
sergiusens
approved these changes
Jun 18, 2024
cjdcordeiro
approved these changes
Jun 19, 2024
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 PR contains two commits:
Readthedocs builds don't fetch tags when cloning the repo. This is a problem
for us because Rockcraft's version comes from the tag (via setuptools-scm),
so do a fetch of the tags as a post-checkout step.
The bug is this: If a build is done off of (say) 'main', the version coming
from 'git describe' will be something like 1.32.2.postXXXX. We previously
dropped the ".post*" suffix because it confused the spellchecker but that
just leaves the misleading "1.32.2" string. It's misleading because that's
an actual released version that does not contain a lot of the content
in 'main'.
So just use "dev" instead, to make it extra explicit that the docs refer
to an unreleased version of the software.
Fixes #584
For reference, this is the setting in RDT's configuration page that makes "stable" be the default version:
