Skip to content

GitHub Action: run renovate bot with an opinionated runner configuration

License

Notifications You must be signed in to change notification settings

open-turo/action-renovate

Repository files navigation

action-renovate

Release Tests pass/fail License Contributions welcome CI semantic-release: angular Conventional commits Join us!

Description

GitHub Action that runs renovatebot with a very opinionated runner configuration. It supports configuring it to talk to private registries for Artifactory, Docker, NPM and Terraform.

Description

GitHub Action that publishes a new release.

Usage

jobs:
  build:
    steps:
      - name: Update dependencies
        uses: open-turo/action-renovate@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

name description required default
dry-run

Whether to run the action in dry-run mode

false ""
checkout-repo

Perform checkout as first step of action

false true
artifactory-username

Username to authenticate against a maven artifactory

false ""
artifactory-password

Password to authenticate against a maven artifactory

false ""
artifactory-username-property-name

Name of the gradle property to use for the artifactory username

false artifactoryUsername
artifactory-password-property-name

Name of the gradle property to use for the artifactory password

false artifactoryAuthToken
artifactory-match-host

A domain name, host name or base URL to match maven artifactory libraries with (see https://docs.renovatebot.com/configuration-options/#matchhost)

false ""
artifactory-registry-urls

A comma separate list of extra registry URLs to tell renovate to use to find new versions of packages (e.g a jfrog registry)

false ""
artifactory-package-prefixes

Package prefix to tell renovate to look for dependencies in the artifactory-registry-urls (e.g com.openTuro)

false ""
docker-username

Username to authenticate against docker hub

false ""
docker-password

Password to authenticate against docker hub

false ""
github-token

GitHub token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'

true ${{ github.token }}
git-ignored-authors

Additional Git authors which are ignored by Renovate. Must conform to RFC5322

false []
log-level

Log level to use for renovate

false info
npm-token

NPM token to use for authentication

false ""
npm-username

Username to authenticate against the NPM registry

false ""
npm-password

Password to authenticate against the NPM registry

false ""
npm-scope

Scope of the packages to use the custom NPM authentication (e.g @open-turo)

false ""
npm-registry

URL of the NPM registry to use the custom authentication for

false ""
terraform-token

Token to authenticate against terraform registry

false ""

Inputs

parameter description required default
checkout-repo Perform checkout as first step of action false true
checkout-fetch-depth The number of commits to fetch. 0 indicates all history for all branches and tags false 0
github-token GitHub token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN' true ${{ github.token }}
docker-config-file Path to the docker config file (defaults to .docker-config.json) Must contain imageName, may contain dockerfile. false .docker-config.json
docker-flavor Docker flavor to use for docker metadata false latest=false
dockerhub-user username for dockerhub false
dockerhub-password password for dockerhub false
npm-auth-token The Node Package Manager (npm) authentication token. This token is used to authenticate against a private NPM registry configured via a .npmrc file. false
npm-token The Node Package Manager (npm) authentication token. This token is used to authenticate against the NPM registry. false
dry-run Whether to run semantic release in dry-run mode. It will override the dryRun attribute in your configuration file false false
extra-plugins Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config. false @open-turo/semantic-release-config

Outputs

parameter description
new-release-published Whether a new release was published
new-release-version Version of the new release
new-release-major-version Major version of the new release

Runs

This action is a composite action.

Runs

This action is a composite action.

Development

Install pre-commit and the commit hooks:

pre-commit install
pre-commit install --hook-type commit-msg

Get Help

Please review Issues, post new Issues against this repository as needed.

Contributions

Please see here for guidelines on how to contribute to this project.