Skip to content

Commit

Permalink
docs(manager/dockerfile): Document supported dependencies for Dockerf…
Browse files Browse the repository at this point in the history
…ile manager (#32288)

Signed-off-by: malmor <62105800+malmor@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
  • Loading branch information
malmor and HonkingGoose authored Nov 3, 2024
1 parent 9b7ae6a commit c73a741
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 3 deletions.
50 changes: 49 additions & 1 deletion lib/modules/manager/dockerfile/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,52 @@
Extracts image references in a `Dockerfile` and/or `Containerfile`.
### Supported dependencies

This manager extracts image references in a `Dockerfile` and/or `Containerfile` and supports:

- [`FROM`](https://docs.docker.com/reference/dockerfile/#from) images
- [`COPY --from`](https://docs.docker.com/reference/dockerfile/#copy---from) images
- [`syntax`](https://docs.docker.com/reference/dockerfile/#syntax) images

#### `FROM` support

Renovate can update images referenced in `FROM` directives.
This even works for multi-stage builds with many `FROM` directives in one Dockerfile.

```dockerfile
FROM node:20.9.0
```

Advanced `FROM` flags like `--platform` or `AS <name>` are also supported:

```dockerfile
FROM --platform=linux/amd64 node:20.9.0 AS installer
```

Also, Renovate will automatically expand variables and [`ARG` directives](https://docs.docker.com/reference/dockerfile/#understand-how-arg-and-from-interact):

```dockerfile
ARG TAG=3.19.4
FROM alpine:${TAG}
```

#### `COPY --from` support

Renovate can update images referenced in `COPY --from` directives.

```dockerfile
FROM node:20.9.0
COPY --from alpine:3.19.4 /bin/sh /usr/local/sh
```

#### `syntax` support

Renovate can update `syntax` references.

```dockerfile
# syntax=docker/dockerfile:1.9.0
FROM alpine:3.19.4
```

### Versioning

Renovate's managers does not understand versioning, that's up to Renovate's versioning modules.
The default `docker` versioning for container image datasources treats suffixes as "compatibility", for example: `-alpine`.
Expand Down
4 changes: 2 additions & 2 deletions lib/modules/manager/flux/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This manager parses [Flux](https://fluxcd.io/) YAML manifests and supports:

1. [`HelmRelease`](https://fluxcd.io/docs/components/helm/helmreleases/) resources
1. ['GitRepository'](https://fluxcd.io/flux/components/source/gitrepositories/) resources
1. ['OCIRepository'](https://fluxcd.io/flux/components/source/ocirepositories/) resources
1. [`GitRepository`](https://fluxcd.io/flux/components/source/gitrepositories/) resources
1. [`OCIRepository`](https://fluxcd.io/flux/components/source/ocirepositories/) resources
1. Flux [system](https://fluxcd.io/docs/installation) manifests

### HelmRelease support
Expand Down

0 comments on commit c73a741

Please # to comment.