diff --git a/README.md b/README.md index ab71b2e..afa8caa 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,13 @@ In that case, you can add an input called `prefix` containing the command that w with: prefix: xvfb-run ``` + +### Customizing installation of package into docs environment + +In some packages, you may want to install the package yourself into the docs environment. For example, if the package is in a subdirectory (but the docs environment is still top-level). In this case, you can pass `install-package: false`. + +```yaml + - uses: julia-actions/julia-docdeploy@v1 + with: + install-package: false +``` diff --git a/action.yml b/action.yml index 2fb6c0b..946f624 100644 --- a/action.yml +++ b/action.yml @@ -11,7 +11,11 @@ inputs: description: 'Value inserted in front of the julia command, e.g. for running xvfb-run julia [...]' default: '' required: false - + install-package: + description: 'Whether or not to install the package with `Pkg.develop` into the `docs` environment' + default: true + required: false + runs: using: 'composite' steps: @@ -32,6 +36,7 @@ runs: # Run the Julia command "${julia_cmd[@]}" shell: bash + if: ${{ inputs.install-package }} - run: | # The Julia command that will be executed julia_cmd=( julia --color=yes --project=docs/ -e '