Skip to content

Commit

Permalink
docs: clarify file naming (#835)
Browse files Browse the repository at this point in the history
* Update README.md

* fix workflow

* chore: prettier-fix

* Update .github/workflows/build.yml

---------

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
  • Loading branch information
rarkins and viceice authored May 4, 2024
1 parent ac583e3 commit e063ae9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ jobs:
strategy:
fail-fast: false
matrix:
configurationFile: [example/renovate-config.js, example/renovate.json]
configurationFile:
- example/renovate-config.js
- example/renovate-config.json
steps:
- name: Checkout
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
Expand Down
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,10 @@ For the available environment variables, see the Renovate [Self-Hosted Configura

### `configurationFile`

Configuration file to configure Renovate.
The supported configurations files:
Configuration file to configure Renovate ("global" config) in JavaScript or JSON format.
It is recommended to not name it one of the repository configuration filenames listed in the Renovate Docs for [Configuration Options](https://docs.renovatebot.com/configuration-options/).

- one of the configuration files listed in the Renovate Docs for [Configuration Options](https://docs.renovatebot.com/configuration-options/)
- or a JavaScript file that exports a configuration object

For both of these options, an example can be found in the [example](./example) directory.
Config examples can be found in the [example](./example) directory.

The configurations that can be done in this file consists of two parts, as listed below.
Refer to the links to the [Renovate Docs](https://docs.renovatebot.com/) for all options.
Expand Down

0 comments on commit e063ae9

Please sign in to comment.