Skip to content

Commit

Permalink
Make Pkg.develop step optional (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericphanson authored Apr 6, 2022
1 parent e6d9f44 commit 9c7706b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
7 changes: 6 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 '
Expand Down

0 comments on commit 9c7706b

Please sign in to comment.