> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# daniel-shuy/renovate

Validate Renovate configuration files, or run a self-hosted instance of Renovate.


## Jobs

### self-hosted

Run a self-hosted instance of Renovate.

WARNING: Do not override cacheDir or RENOVATE_CACHE_DIR, or caching will be disabled, as this Orb does not support alternate cache directory locations as the moment.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `cache_version` | string | v1 | Change the default cache version if you need to clear the cache for any reason. |
| `config_file_path` | string | config.js | Path to configuration file (see https://docs.renovatebot.com/self-hosted-configuration/ for configuration options). |
| `log_level` | string | info | Setting the log level to get more/less granular logs. More info: https://docs.renovatebot.com/examples/self-hosting/#logging |
| `renovate_version` | string |  | Version of Renovate to run (if no version is specified, runs the latest version). |
| `resource_class` | string | medium | Amount of CPU and RAM allocated to each container in a job. |
| `slim` | boolean | false | Use "slim" Docker images to reduce startup time.
Set to true if you only use package managers that don't need third party binaries (e.g. JS, Docker, Nuget, pip).
 |
| `with_cache` | boolean | true | Share Renovate cache between runs. |

### validate-config

Validate Renovate configuration file.
Configuration file definition: https://docs.renovatebot.com/configuration-options/


| Parameter | Type | Default | Description |
|---|---|---|---|
| `renovate_version` | string |  | Override this with the Renovate version if you are using a self-hosted instance of Renovate, else leave it empty. |
| `resource_class` | string | medium | Amount of CPU and RAM allocated to each container in a job. |

### validate-self-hosted-config

Validate Renovate self-hosted configuration file.
Self-hosted configuration file docs: https://github.com/renovatebot/renovate/blob/master/docs/usage/self-hosting.md#user-content-configuration


| Parameter | Type | Default | Description |
|---|---|---|---|
| `renovate_version` | string |  | The version of your self-hosted instance of Renovate. |
| `resource_class` | string | medium | Amount of CPU and RAM allocated to each container in a job. |
| `self_hosted_config_file_path` | string | config.js | Path to self-hosted configuration file. |

## Executors

### default

Docker image for Renovate CLI


| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | latest | Pick a specific renovate/renovate image variant:
https://hub.docker.com/r/renovate/renovate/tags
Use the "slim" tag if you only use package managers that don't need third party binaries (e.g. JS, Docker, Nuget, pip)
 |

## Examples

### self-hosted

Run a self-hosted instance of Renovate.

Configuration:
1. Create a Renovate self-hosted configuration file (eg. renovate-config.js).
2. Pass the file path into the config_file_path parameter.
3. Commit and push the changes to the branch configured in the schedule filter branch. This is usually the default branch (eg. master).
For more information, see:
• https://github.com/renovatebot/renovate/blob/master/docs/usage/self-hosting.md#user-content-configuration
• https://github.com/renovatebot/renovate/blob/master/docs/usage/self-hosted-configuration.md
• https://docs.renovatebot.com/self-hosted-configuration

Secrets should be configured using environment variables (eg. RENOVATE_TOKEN, GITHUB_COM_TOKEN).

Configure environment variables in CircleCI Project Settings. To share environment variables across projects, use CircleCI Contexts (https://circleci.com/docs/2.0/contexts/).

For more information and examples, see: https://github.com/renovatebot/renovate/blob/master/docs/usage/self-hosting.md

The example below runs Renovate hourly:


```yaml
version: '2.1'
orbs:
  renovate: daniel-shuy/renovate@x.y
workflows:
  renovate:
    jobs:
      - renovate/self-hosted:
          config_file_path: renovate-config.js
    nightly:
      triggers:
        - schedule:
            cron: 0 * * * *
            filters:
              branches:
                only:
                  - master
```

### validate-config

Validate Renovate configuration file.

Configuration file definition: https://docs.renovatebot.com/configuration-options/


```yaml
version: '2.1'
orbs:
  renovate: daniel-shuy/renovate@x.y
workflows:
  lint:
    jobs:
      - renovate/validate-config
```

### validate-self-hosted-config

Validate Renovate self-hosted configuration file.

Self-hosted configuration file docs: https://github.com/renovatebot/renovate/blob/master/docs/usage/self-hosting.md#user-content-configuration

Override self_hosted_config_file_path if the self-hosted configuration file is not at the default path (config.js).


```yaml
version: '2.1'
orbs:
  renovate: daniel-shuy/renovate@x.y
workflows:
  lint:
    jobs:
      - renovate/validate-self-hosted-config:
          renovate_version: $RENOVATE_VERSION
          self_hosted_config_file_path: renovate.config.js
```