Skip to content

Commit

Permalink
docs: add docs about refetch option
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox committed Jun 3, 2024
1 parent fba8480 commit 01dce88
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,10 @@ remotes:

An optional *branch* or *tag* name.

> [!NOTE]
>
> If you initially had `ref` option, ran `lefthook install`, and then removed it, lefthook won't decide which branch/tag to use as a ref. So, if you added it once, please, use it always to avoid issues in local setups.
**Example**

```yml
Expand All @@ -474,9 +478,21 @@ remotes:
ref: v1.0.0
```

> [!NOTE]
>
> If you initially had `ref` option, ran `lefthook install`, and then removed it, lefthook won't decide which branch/tag to use as a ref. So, if you added it once, please, use it always to avoid issues in local setups.
### `refetch`

**Default:** `false`

Force remote config refetching on every run. Lefthook will be refetching the specified remote every time it is called.

**Example**

```yml
# lefthook.yml

remotes:
- git_url: https://github.com/evilmartians/lefthook
refetch: true
```

### `configs`

Expand Down

0 comments on commit 01dce88

Please sign in to comment.