1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www/content/docker.md

127 lines
3.0 KiB
Markdown
Raw Normal View History

---
title: Docker
series: customization
hideFromIndex: true
weight: 140
---
Since [v0.31.0](https://github.com/goreleaser/goreleaser/releases/tag/v0.31.0),
GoReleaser supports building and pushing Docker images.
## How it works
You can declare multiple Docker images. They will be matched against
the binaries generated by your `builds` section.
If you have only one `build` setup,
the configuration is as easy as adding the
name of your image to your `.goreleaser.yml` file:
```yaml
dockers:
- image: user/repo
```
You also need to create a `Dockerfile` in your project's root folder:
```dockerfile
FROM scratch
COPY mybin /
ENTRYPOINT ["/mybin"]
```
This configuration will build and push a Docker image named `user/repo:tagname`.
## Customization
Of course, you can customize a lot of things:
```yaml
# .goreleaser.yml
dockers:
# You can have multiple Docker images.
-
# GOOS of the built binary that should be used.
goos: linux
# GOARCH of the built binary that should be used.
goarch: amd64
# GOARM of the built binary that should be used.
goarm: ''
# Name of the built binary that should be used.
binary: mybinary
# Docker image name.
image: myuser/myimage
2018-03-24 23:42:21 +02:00
# Skips the docker push. Could be useful if you also do draft releases.
# Defaults to false.
skip_push: false
# Path to the Dockerfile (from the project root).
dockerfile: Dockerfile
# Template of the docker tag. Defaults to `{{ .Version }}`.
# Other allowed fields are:
# - `.Commint`
# - `.Tag`
# - `.Major`
# - `.Minor`
# - `.Patch`
# - `.Env.VARIABLE_NAME`
2018-01-18 21:41:56 +02:00
tag_templates:
- "{{ .Tag }}"
- "{{ .Tag }}-{{ .Env.GO_VERSION }}"
2018-01-19 04:05:09 +02:00
- "v{{ .Major }}"
2018-01-18 21:41:56 +02:00
- latest
# If your Dockerfile copies files other than the binary itself,
# you should list them here as well.
extra_files:
- config.yml
```
These settings should allow you to generate multiple Docker images,
for example, using multiple `FROM` statements,
as well as generate one image for each binary in your project.
## Passing environment variables to tag_template
You can do that by using `{{ .Env.VARIABLE_NAME }}` in the template, for
example:
```yaml
dockers:
-
tag_template: "{{ .Tag }}-{{ .Env.GOVERSION_NR }}"
```
Then you can run:
```console
GOVERSION_NR=$(go version | awk '{print $3}') goreleaser
```
2018-01-19 04:05:09 +02:00
## Keeping docker images updated for current major
Some users might want to when version to push docker tags `:v1`, `:v1.6`,
`:v1.6.4` and `:latest` when `v1.6.4` (for example) is built. That can be
accomplished by using multiple `tag_templates`:
```yaml
# .goreleaser.yml
dockers:
-
binary: mybinary
image: myuser/myimage
tag_templates:
- "{{ .Tag }}"
- "v{{ .Major }}"
- "v{{ .Major }}.{{ .Minor }}"
- latest
```
This will build and publish the following images:
* myuser/myimage:v1.6.4
* myuser/myimage:v1
* myuser/myimage:v1.6
* myuser/myimage:latest
2018-02-19 01:37:59 +02:00
With these settings you can hopefully push several different docker images
with multiple tags.