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.

Sign up for GitHub

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

docs(manager/dockerfile): Document supported dependencies for Dockerfile manager #32288

Merged
merged 4 commits into from
Nov 3, 2024
Merged

docs(manager/dockerfile): Document supported dependencies for Dockerfile manager #32288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58230b2
Document supported dependencies for Dockerfile manager
malmor Nov 1, 2024
ab1f2ed
Ordered lists should be unnumbered
malmor Nov 2, 2024
6405b42
Use a plain list instead of a numbered list
malmor Nov 3, 2024
74e6278
Only one sentence per line, use simpler words
malmor Nov 3, 2024
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
50 changes: 49 additions & 1 deletion lib/modules/manager/dockerfile/readme.md
View file
Open in desktop
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
View file
Open in desktop
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