fix(docs): show the latest release tag as the API reference version - #144
Merged
Merged
Conversation
Dokka displayed the git-describe artifact version (e.g. 1.2.10-11-g3368f3d-SNAPSHOT) in the API reference header. The reference is published from main and the rest of the site advertises the released version, so moduleVersion now resolves to the last v* tag, falling back to project.version when no tag is reachable. Co-Authored-By: Claude <noreply@anthropic.com>
2 tasks
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
1 participant
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.
Summary
The Dokka header read
Metalastic 1.2.10-11-g3368f3d-SNAPSHOT, the git-describe version used for artifacts. The reference is generated frommainand the rest of the docs site shows the released version, sodokka.moduleVersionnow resolves to the lastv*tag (1.2.10today), withproject.versionas fallback when no tag is reachable (shallow checkout). On a tag build both values coincide.Test plan
./gradlew dokkaGenerate: header shows1.2.10, noSNAPSHOTstring anywhere indocs/public/api./gradlew spotlessCheck/Metalastic/api/header after merge (the deploy workflow usesfetch-depth: 0, so tags are available)Co-Authored-By: Claude noreply@anthropic.com