Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for julia hooks #998

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions sections/new-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,37 @@ This language supports `additional_dependencies` so it can be used as a
__Support:__ haskell hooks are known to work on any system which has `cabal`
installed. It has been tested on linux, macOS, and windows.

### julia

_new in 4.x.0_

The hook repository must contain a `Project.toml` file and optionally a `Manifest.toml`
file. Hooks will run in this environment.

For configuring julia hooks, your [`entry`](#hooks-entry) should be a path to a julia source
file relative to the hook repository (optionally with arguments).

For example:

```yaml
- id: foo-without-args
name: ...
language: julia
entry: bin/foo.jl
- id: bar-with-args
name: ...
language: julia
entry: bin/bar.jl --arg1 --arg2
```

This language supports `additional_dependencies` so it can be used as a `repo: local` hook.
`additional_dependencies` are passed to `pkg> add` and should be specified using
[Pkg REPL mode syntax](https://pkgdocs.julialang.org/v1/repl/#repl-add).
Note that `additional_dependencies` can be used to override package versions in the
`Project.toml` file of the hook repository.

__Support:__ julia hooks are known to work on any system which has `julia` installed.

### lua

Lua hooks are installed with the version of Lua that is used by Luarocks.
Expand Down
Loading