feat!: drop useSlim and use `latest' tag (#782)

BREAKING CHANGE: The action now uses the slim renovate version by default.
This commit is contained in:
Michael Kriese 2023-07-12 14:19:26 +02:00 committed by GitHub
parent 15c94446ef
commit 89ff8f7bf9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 32 deletions

11
.github/renovate.json vendored
View file

@ -29,11 +29,6 @@
"description": "Use ci semantic type for some deps", "description": "Use ci semantic type for some deps",
"matchFileNames": [".github/workflows/**"], "matchFileNames": [".github/workflows/**"],
"semanticCommitType": "ci" "semanticCommitType": "ci"
},
{
"description": "Use slim tags for renovate",
"matchDepNames": ["renovate"],
"extractVersion": "^(?<version>\\d+\\.\\d+\\.\\d+)-slim$"
} }
], ],
"regexManagers": [ "regexManagers": [
@ -44,6 +39,12 @@
], ],
"depNameTemplate": "renovatebot/github-action", "depNameTemplate": "renovatebot/github-action",
"datasourceTemplate": "github-releases" "datasourceTemplate": "github-releases"
},
{
"fileMatch": ["^README\\.md$"],
"matchStrings": ["renovate-version: (?<currentValue>[^\\s]+)"],
"depNameTemplate": "ghcr.io/renovatebot/renovate",
"datasourceTemplate": "docker"
} }
] ]
} }

View file

@ -16,7 +16,6 @@ GitHub Action to run Renovate self-hosted.
- [`token`](#token) - [`token`](#token)
- [`renovate-image`](#renovate-image) - [`renovate-image`](#renovate-image)
- [`renovate-version`](#renovate-version) - [`renovate-version`](#renovate-version)
- [`useSlim`](#useslim)
- [Example](#example) - [Example](#example)
- [Environment Variables](#environment-variables) - [Environment Variables](#environment-variables)
- [Passing other environment variables](#passing-other-environment-variables) - [Passing other environment variables](#passing-other-environment-variables)
@ -97,7 +96,7 @@ The Renovate Docker image name to use.
If omitted or `renovate-image === ''` the action will use the `ghcr.io/renovatebot/renovate` Docker image name otherwise. If omitted or `renovate-image === ''` the action will use the `ghcr.io/renovatebot/renovate` Docker image name otherwise.
If a Docker image name is defined, the action will use that name to pull the image. If a Docker image name is defined, the action will use that name to pull the image.
This sample will use `myproxyhub.domain.com/renovate/renovate:slim` image. This sample will use `myproxyhub.domain.com/renovate/renovate` image.
```yml ```yml
.... ....
@ -114,7 +113,7 @@ jobs:
token: ${{ secrets.RENOVATE_TOKEN }} token: ${{ secrets.RENOVATE_TOKEN }}
``` ```
This sample will use `ghcr.io/renovatebot/renovate:slim` image. This sample will use `ghcr.io/renovatebot/renovate` image.
```yml ```yml
.... ....
@ -133,11 +132,10 @@ jobs:
### `renovate-version` ### `renovate-version`
The Renovate version to use. The Renovate version to use.
If omitted and `useSlim !== false` the action will use the `slim` Docker tag and the `latest` tag otherwise. If omitted the action will use the `latest` Docker tag.
If a version is defined, the action will add `-slim` suffix to the tag if `useSlim !== false`.
Check [the available tags on Docker Hub](https://hub.docker.com/r/renovate/renovate/tags). Check [the available tags on Docker Hub](https://hub.docker.com/r/renovate/renovate/tags).
This sample will use `ghcr.io/renovatebot/renovate:35.103.0-slim` image. This sample will use `ghcr.io/renovatebot/renovate:35.103.0` image.
```yml ```yml
.... ....
@ -150,11 +148,11 @@ jobs:
- name: Self-hosted Renovate - name: Self-hosted Renovate
uses: renovatebot/github-action@v38.1.6 uses: renovatebot/github-action@v38.1.6
with: with:
renovate-version: 35.0.0 renovate-version: 35.103.0
token: ${{ secrets.RENOVATE_TOKEN }} token: ${{ secrets.RENOVATE_TOKEN }}
``` ```
This sample will use `ghcr.io/renovatebot/renovate:latest` image. This sample will use `ghcr.io/renovatebot/renovate:full` image.
```yml ```yml
.... ....
@ -167,15 +165,12 @@ jobs:
- name: Self-hosted Renovate - name: Self-hosted Renovate
uses: renovatebot/github-action@v38.1.6 uses: renovatebot/github-action@v38.1.6
with: with:
useSlim: false renovate-version: full
token: ${{ secrets.RENOVATE_TOKEN }} token: ${{ secrets.RENOVATE_TOKEN }}
``` ```
We recommend you pin the version of Renovate to a full version or a full checksum, and use Renovate's regex manager to create PRs to update the pinned version. We recommend you pin the version of Renovate to a full version or a full checksum, and use Renovate's regex manager to create PRs to update the pinned version.
See `.github/workflows/build.yml` for an example of how to do this.
### `useSlim`
If set to `false` the action will use the full Renovate image instead of the slim image.
## Example ## Example

View file

@ -16,11 +16,6 @@ inputs:
configured using a Secret. Either use this input or the 'RENOVATE_TOKEN' configured using a Secret. Either use this input or the 'RENOVATE_TOKEN'
environment variable. environment variable.
required: false required: false
useSlim:
description: |
Use a lightweight renovate container without any third-party binaries.
Defaults to true if not set.
required: false
env-regex: env-regex:
description: | description: |
Override the environment variables which will be passsed into the renovate container. Override the environment variables which will be passsed into the renovate container.

View file

@ -10,11 +10,7 @@ class Docker {
const tag = input.getVersion(); const tag = input.getVersion();
this.dockerImage = input.getDockerImage() ?? Docker.image; this.dockerImage = input.getDockerImage() ?? Docker.image;
this.fullTag = input.useSlim() this.fullTag = tag ?? 'latest';
? tag
? `${tag}-slim`
: 'slim'
: tag ?? 'full';
} }
image(): string { image(): string {

View file

@ -60,10 +60,6 @@ class Input {
return null; return null;
} }
useSlim(): boolean {
return core.getInput('useSlim') !== 'false';
}
getDockerImage(): string | null { getDockerImage(): string | null {
return core.getInput('renovate-image') || null; return core.getInput('renovate-image') || null;
} }