README.md

Github Action Renovatebot

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.

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	""
env-regex	Override the environment variables which will be passsed into the renovate container. Defaults to ^(?:RENOVATE_\w+	LOG_LEVEL	GITHUB_COM_TOKEN
extra-config	Extra configuration to pass to renovate. It has to be a valid JSON object. Use with caution as this could override the default configuration created by this action	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	""

Runs

This action is a composite action.

Usage

- uses: open-turo/action-renovate@v1
  with:
    dry-run:
    # Whether to run the action in dry-run mode
    #
    # Required: false
    # Default: ""

    checkout-repo:
    # Perform checkout as first step of action
    #
    # Required: false
    # Default: true

    artifactory-username:
    # Username to authenticate against a maven artifactory
    #
    # Required: false
    # Default: ""

    artifactory-password:
    # Password to authenticate against a maven artifactory
    #
    # Required: false
    # Default: ""

    artifactory-username-property-name:
    # Name of the gradle property to use for the artifactory username
    #
    # Required: false
    # Default: artifactoryUsername

    artifactory-password-property-name:
    # Name of the gradle property to use for the artifactory password
    #
    # Required: false
    # Default: 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)
    #
    # Required: false
    # Default: ""

    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)
    #
    # Required: false
    # Default: ""

    artifactory-package-prefixes:
    # Package prefix to tell renovate to look for dependencies in the artifactory-registry-urls (e.g com.openTuro)
    #
    # Required: false
    # Default: ""

    env-regex:
    # Override the environment variables which will be passsed into the renovate container. Defaults to `^(?:RENOVATE_\\w+|LOG_LEVEL|GITHUB_COM_TOKEN|NODE_OPTIONS|(?:HTTPS?|NO)_PROXY|(?:https?|no)_proxy)# Github Action Renovatebot

<!-- prettier-ignore-start -->

    #
    # Required: false
    # Default: ""

    extra-config:
    # Extra configuration to pass to renovate. It has to be a valid JSON object. Use with caution as this could override the default configuration created by this action
    #
    # Required: false
    # Default: {}

    docker-username:
    # Username to authenticate against docker hub
    #
    # Required: false
    # Default: ""

    docker-password:
    # Password to authenticate against docker hub
    #
    # Required: false
    # Default: ""

    github-token:
    # GitHub token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'
    #
    # Required: true
    # Default: ${{ github.token }}

    git-ignored-authors:
    # Additional Git authors which are ignored by Renovate. Must conform to RFC5322
    #
    # Required: false
    # Default: []

    log-level:
    # Log level to use for renovate
    #
    # Required: false
    # Default: info

    npm-token:
    # NPM token to use for authentication
    #
    # Required: false
    # Default: ""

    npm-username:
    # Username to authenticate against the NPM registry
    #
    # Required: false
    # Default: ""

    npm-password:
    # Password to authenticate against the NPM registry
    #
    # Required: false
    # Default: ""

    npm-scope:
    # Scope of the packages to use the custom NPM authentication (e.g @open-turo)
    #
    # Required: false
    # Default: ""

    npm-registry:
    # URL of the NPM registry to use the custom authentication for
    #
    # Required: false
    # Default: ""

    terraform-token:
    # Token to authenticate against terraform registry
    #
    # Required: false
    # Default: ""