This repository was archived by the owner on Jun 26, 2024. It is now read-only.
Enable site generation using GitHub sources to enable multi-version docs in gh-pages #1145
Conversation
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
Signed-off-by: Pavel Macík <[email protected]>
pmacik
added
kind/documentation
|
/retest |
Codecov Report
@@ Coverage Diff @@
## master #1145 +/- ##
=======================================
Coverage 57.84% 57.84%
=======================================
Files 31 31
Lines 2697 2697
=======================================
Hits 1560 1560
Misses 976 976
Partials 161 161 Continue to review full report at Codecov.
|
pmacik
changed the title
|
/lgtm |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dperaza4dustbit The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Pavel Macík [email protected]
Follows-up to #1144
Changes
To enable multi-version site generation, antora configuration needs to have the version branches available. Currently, the antora is setup to use the local repo only. However, the CI job to generate docs on merge-to-master only fetches the
masterbranch for it's local repo from which the site is generated, and so it misses the other "version" branches resulting in missing the version toggle introduced in #1144.This PR:
To generate site using github repo as a remote source:
Note:
The default
make siteis equivalent to:Submitter Checklist
As the author of this PR, please check off the items in this checklist:
included if any changes are user facing
included if any functionality added or changed. For bugfixes please include tests that can catch regressions
@external-feedbacktag.