actions/renovatebot-github
1
0
Fork 0
mirror of https://github.com/renovatebot/github-action.git synced 2025-12-27 12:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Mike Ryan 2024-08-27 12:48:19 -05:00 • committed by GitHub
parent 328efab690
commit 3585ba6a24
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -13,11 +13,11 @@ GitHub Action to run Renovate self-hosted.
- [`configurationFile`](#configurationfile) - [`configurationFile`](#configurationfile)
- [`docker-cmd-file`](#docker-cmd-file) - [`docker-cmd-file`](#docker-cmd-file)
- [`docker-network`](#docker-network) - [`docker-network`](#docker-network)
- [`docker-socket-host-path`](#docker-socket-host-path)
- [`docker-user`](#docker-user) - [`docker-user`](#docker-user)
- [`docker-volumes`](#docker-volumes) - [`docker-volumes`](#docker-volumes)
- [`env-regex`](#env-regex) - [`env-regex`](#env-regex)
- [`mount-docker-socket`](#mount-docker-socket) - [`mount-docker-socket`](#mount-docker-socket)
- [`docker-socket-host-path`](#docker-socket-host-path)
- [`token`](#token) - [`token`](#token)
- [`renovate-image`](#renovate-image) - [`renovate-image`](#renovate-image)
- [`renovate-version`](#renovate-version) - [`renovate-version`](#renovate-version)
@ -114,6 +114,12 @@ Specify a network to run container in.
You can use `${{ job.container.network }}` to run renovate container [in the same network as other containers for this job](https://docs.github.com/en/actions/learn-github-actions/contexts#job-context), You can use `${{ job.container.network }}` to run renovate container [in the same network as other containers for this job](https://docs.github.com/en/actions/learn-github-actions/contexts#job-context),
or set it to `host` to run in the same network as github runner, or specify any custom network. or set it to `host` to run in the same network as github runner, or specify any custom network.
### `docker-socket-host-path`
Allows the overriding of the host path for the Docker socket that is mounted into the container.
Useful on systems where the host Docker socket is located somewhere other than `/var/run/docker.sock` (the default).
Only applicable when `mount-docker-socket` is true.
### `docker-user` ### `docker-user`
Specify a user (or user-id) to run docker command. Specify a user (or user-id) to run docker command.
@ -158,12 +164,6 @@ inside the renovate container so that the commands can use Docker. Can be useful
for `postUpgradeTasks`'s commands. Also add the user inside the renovate for `postUpgradeTasks`'s commands. Also add the user inside the renovate
container to the docker group for socket permissions. container to the docker group for socket permissions.
## `docker-socket-host-path`
Allows the overriding of the host path for the Docker socket that is mounted into the container.
Useful on systems where the host Docker socket is located somewhere other than `/var/run/docker.sock` (the default).
Only applicable when `mount-docker-socket` is true.
### `token` ### `token`
[Generate a Personal Access Token (classic)](https://github.com/settings/tokens), with the `repo:public_repo` scope for only public repositories or the `repo` scope for public and private repositories, and add it to _Secrets_ (repository settings) as `RENOVATE_TOKEN`. [Generate a Personal Access Token (classic)](https://github.com/settings/tokens), with the `repo:public_repo` scope for only public repositories or the `repo` scope for public and private repositories, and add it to _Secrets_ (repository settings) as `RENOVATE_TOKEN`.