Skip to content

Commit

Permalink
docs(circleci): explain private orbs hostRules (#15939)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed Jun 10, 2022
1 parent 04e789c commit bb44a4b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions lib/modules/manager/circleci/readme.md
@@ -1,3 +1,29 @@
The `circleci` manager extracts both `docker` as well as `orb` datasources from CircleCI config files.

If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.

### Private orbs

To get private orbs working you should:

1. Encrypt your CircleCI token with the [Renovate encryption page](https://app.renovatebot.com/encrypt)
1. Create a new `hostRules` entry in your Renovate config file
1. Put the encrypted token in the `token` field

The end-result should look like this:

```json
{
"hostRules": [
{
"matchHost": "circleci.com",
"authType": "Token-Only",
"encrypted": {
"token": "****"
}
}
]
}
```

This config strips the Bearer/Basic prefix from the `authorization` header.

0 comments on commit bb44a4b

Please sign in to comment.