1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www/docs/customization/hooks.md
Carlos Alexandro Becker 3d2f82461f
docs: improve hooks, fix typo
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
2021-09-22 23:37:30 -03:00

1.9 KiB

title
Global Hooks

Some release cycles may need run something before or after everything else.

GoReleaser allows this with the global hooks feature.

=== "OSS" The before section allows for global hooks which will be executed before the build is started.

The configuration is very simple, here is a complete example:

```yaml
# .goreleaser.yml
before:
  # Templates for the commands to be ran.
  hooks:
  - make clean
  - go generate ./...
  - go mod tidy
  - touch {{ .Env.FILE_TO_TOUCH }}
```

=== "PRO" !!! success "GoReleaser Pro" Global after hooks and the additional options in before hooks are GoReleaser Pro features.

With [GoReleaser Pro](/pro/), things are a bit more flexible: you can specify the dir, environment variables and also global after hooks:

```yaml
# .goreleaser.yml
# global before hooks
before:
  # Templates for the commands to be ran.
  hooks:
  - make clean # simple string
  - cmd: go generate ./... # specify cmd
  - cmd: go mod tidy
    dir: ./submodule # specify command working directory
  - cmd: touch {{ .Env.FILE_TO_TOUCH }}
    env:
      FILE_TO_TOUCH: 'something-{{ .ProjectName }}' # specify hook level environment variables

# global after hooks
after:
  # Templates for the commands to be ran.
  hooks:
  - make clean
  - cmd: cat *.yaml
    dir: ./submodule
  - cmd: touch {{ .Env.RELEASE_DONE }}
    env:
      RELEASE_DONE: 'something-{{ .ProjectName }}' # specify hook level environment variables
```

If any of the hooks fails the release process is aborted.

Complex commands

If you need to do anything more complex, it is recommended to create a shell script and call it instead. You can also go crazy with sh -c "my commands", but it gets ugly really fast.

!!! tip Learn more about the name template engine.