Document how to source platform/library dependencies from private repo #174
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
The action supports installing platform and library dependencies of the sketches by cloning the repository specified via the source-url field of the platforms or libraries inputs. The information provided in the relevant documentation in the readme should be sufficient for the action user to accomplish this when the dependency is in a public repository. Although that information is also applicable for private repositories, it is more complex to make the necessary configuration of the workflow, repository, and user account. So the users might appreciate some additional guidance for this use case. Since this configuration is general to using Git, GitHub, and GitHub Actions workflows rather than something specific to the action itself, it is out of scope for the primary documentation in the readme. An item in the supplemental FAQ will be the most appropriate place for this information.
per1234
added
topic: documentation
3 tasks
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.
The action supports installing platform and library dependencies of the sketches by cloning the repository specified via the
source-urlfield of theplatformsorlibrariesinputs.The information provided in the relevant documentation in the readme should be sufficient for the action user to accomplish this when the dependency is in a public repository. Although that information is also applicable for private repositories, it is more complex to make the necessary configuration of the workflow, repository, and user account. So the users might appreciate some additional guidance for this use case.
Since this configuration is general to using Git, GitHub, and GitHub Actions workflows rather than something specific to
the action itself, it is out of scope for the primary documentation in the readme. An item in the supplemental FAQ will be the most appropriate place for this information.
The rendered content can be previewed here:
https://github.com/per1234/compile-sketches/blob/private-dep-faq/docs/FAQ.md#how-can-i-install-a-platform-or-library-dependency-from-an-external-private-repository
Related: #167