GitHub Action to run Renovate self-hosted.
This project has been moved to renovate/github-action and is no longer maintained here.
This has started as my personal project has since been taken over by Renovate as its official GitHub Action. That was wonderful news since that allows this project to reach more people and having it as official GitHub Action might help users find and trust this Action. I'm still an active contributer, but now at renovate/github-action!
Please refer to renovate/github-action for the latest version.
| Badge | Description | Service |
|---|---|---|
 |
Code style | Prettier |
 |
Commit style | Conventional Commits |
 |
Dependencies | Renovate |
 |
Lint commit messages | GitHub Actions |
 |
Lint | GitHub Actions |
 |
Example | GitHub Actions |
Configuration file to configure Renovate. The configurations that can be done in this file consists of two parts, as listed below. Refer to the links to the Renovate Docs for all options and see the example/config.js for an example configuration.
The branchPrefix option is important to configure and should be configured to a value other than the default to prevent interference with e.g. the Renovate GitHub App.
Generate a personal access token, 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. You can also create a token without a specific scope, which gives read-only access to public repositories, for testing. This token is only used by Renovate, see the token configuration, and gives it access to the repositories. The name of the secret can be anything as long as it matches the argument given to the token option.
Note that the GITHUB_TOKEN secret can't be used for authenticating Renovate.
This example uses a personal access token and will run every 15 minutes. The personal access token is configured as a GitHub secret named RENOVATE_TOKEN. This example uses the example/config.js file as configuration.
You can also see a live example of this action in my github-renovate repository, which also includes a more advanced configuration for updating GitHub Action workflows.
name: Renovate
on:
schedule:
# The "*" (#42, asterisk) character has special semantics in YAML, so this
# string has to be quoted.
- cron: '0/15 * * * *'
jobs:
renovate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2.0.0
- name: Self-hosted Renovate
uses: vidavidorra/github-action-renovate@v1.0.0
with:
configurationFile: example/config.js
token: ${{ secrets.RENOVATE_TOKEN }}This project is licensed under the GPLv3 license.
Copyright © 2020 Jeroen de Bruijn
License details.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
The full text of the license is available in the LICENSE file in this repository and online.