Add support for user-provided python packages #5626
Merged
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.
Hi @squidfunk
With this PR I wanted to solve a challenge of onboarding user-provided packages to the mkdocs-build artifact.
Even though build workflow includes some plugins by default, the list is not extensive, nor it assumes that users should edit it.
With this little change the workflow for users who want to install additional plugins/packages is as follows:
the build workflow will copy to the build context all files ending with *requirements.txt and then a new bash command will start
pip install -r user-requirements.txt
if the user-requirements.txt files was found in the repo.That way we provide flexibility in what users can install on top of the default plugins.
PS. This is a backwards compatible change, nothing is required from users who don't want to have custom packages installed.
If you agree with this change, I can raise a similar PR against insiders.