[skip changelog] Use local path for github.com/arduino/arduino-cli module dependency of docsgen #719
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
…dule dependency of docsgen Previously, docsgen used a pinned version of the github.com/arduino/arduino-cli module, which resulted in the generated command documentation not reflecting updates to the Arduino CLI command line interface made after the pinned version. The new approach is to use the current version of the module from the local path, resulting in the generated documentation always matching the associated version of Arduino CLI.
per1234
added
component/CLI
topic: documentation
|
👍 👍 👍 |
rsora
pushed a commit
that referenced
this pull request
May 22, 2020
…dule dependency of docsgen (#719) Previously, docsgen used a pinned version of the github.com/arduino/arduino-cli module, which resulted in the generated command documentation not reflecting updates to the Arduino CLI command line interface made after the pinned version. The new approach is to use the current version of the module from the local path, resulting in the generated documentation always matching the associated version of Arduino CLI. (cherry picked from commit 8220b32)
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
Cause the command line interface documentation generation system to use the
github.com/arduino/arduino-climodule from the local path.As reported in #714, previously, the generated documentation for the command line interface did not reflect recent development work. This is caused by
docsgenusing a pinned version of thegithub.com/arduino/arduino-climodule, which resulted in the the documentation only applying to the interface of the pinned version of Arduino CLI.The generated command line interface documentation will always match the code at its state when the documentation was generated.
No.
Fixes #714
Generated docs: https://per1234.github.io/arduino-cli/4.2/commands/arduino-cli/