-
-
Notifications
You must be signed in to change notification settings - Fork 403
Add versioning to docs #711
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
rsora
reviewed
May 20, 2020
env: | ||
REMOTE: https://x-access-token:${{secrets.GITHUB_TOKEN}}@github.com/${{github.repository}}.git | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An unwanted blank line maybe?
rsora
approved these changes
May 20, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent!
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.
Please check if the PR fulfills these requirements
This PR introduces Mike to wrap Mkdocs execution so that we can build different docs for each different Arduino CLI version.
At the moment docs are built and published at every merge on
master
, meaning that the docs might contain unreleased features.We'll add:
a special
latest
version of the docs pointing to the most recent Arduino CLI release: these docs will be shown by default when landing to https://arduino.github.io/arduino-cli/a special
dev
version of the docs, documenting whatever we have onmaster
at every commita selector to pick the right version of the docs for the Arduino CLI version users have installed
Does this PR introduce a breaking change?
No, existing docs will be preserved, new ones will follow the versioning strategy.
See how to contribute