Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(circleci): explain private orbs hostRules (#15939)
- Loading branch information
1 parent
04e789c
commit bb44a4b
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |