Add support and bump to mike 2.0.0
#174
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
part:tests
llucax
added
part:tooling
Closed
github-actions
bot
removed
part:tooling
llucax
added
part:tooling
Signed-off-by: Leandro Lucarella <[email protected]>
This commit upgrades `mike` to 2.0.0. This new version uses symlinks for aliases by default, but they are not supported by GitHub Pages, so we need to use the `redirect` alias type instead explicitly. We use the new `alias_type` option in the `mike` plugin configuration in the `mkdocs.yml` file to set the alias type to `redirect`. Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
removed
part:tooling
If the `mike` version can't be determined, just emit a warning and exit succesfully. This is useful for the CI, where the `mike` version can't be determined because the branch name doesn't follow the guidelines (for example in PRs). The CI will now emit a warning and skip the publishing of the documentation website. Signed-off-by: Leandro Lucarella <[email protected]>
This was referenced Nov 6, 2023
daniel-zullo-frequenz
approved these changes
Nov 6, 2023
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 upgrades
miketo 2.0.0. This new version uses symlinks for aliases by default, but they are not supported by GitHub Pages, so we need to use theredirectalias type instead explicitly.We use the new
alias_typeoption in themikeplugin configuration in themkdocs.ymlfile to set the alias type toredirect.It also avoid failing the documentation publishing job if the
mikeversion can't be determined (for example if the branch name is not recognized). It will just emit a warning and skip the publishing.Fixes #173.