mirror of
https://github.com/renovatebot/github-action.git
synced 2025-12-16 17:02:36 +00:00
docs: clarify file naming (#835)
* Update README.md * fix workflow * chore: prettier-fix * Update .github/workflows/build.yml --------- Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
This commit is contained in:
parent
ac583e37d5
commit
e063ae963e
2 changed files with 6 additions and 7 deletions
4
.github/workflows/build.yml
vendored
4
.github/workflows/build.yml
vendored
|
|
@ -64,7 +64,9 @@ jobs:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
configurationFile: [example/renovate-config.js, example/renovate.json]
|
configurationFile:
|
||||||
|
- example/renovate-config.js
|
||||||
|
- example/renovate-config.json
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
|
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
|
||||||
|
|
|
||||||
|
|
@ -44,13 +44,10 @@ For the available environment variables, see the Renovate [Self-Hosted Configura
|
||||||
|
|
||||||
### `configurationFile`
|
### `configurationFile`
|
||||||
|
|
||||||
Configuration file to configure Renovate.
|
Configuration file to configure Renovate ("global" config) in JavaScript or JSON format.
|
||||||
The supported configurations files:
|
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/)
|
Config examples can be found in the [example](./example) directory.
|
||||||
- or a JavaScript file that exports a configuration object
|
|
||||||
|
|
||||||
For both of these options, an example can be found in the [example](./example) directory.
|
|
||||||
|
|
||||||
The configurations that can be done in this file consists of two parts, as listed below.
|
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.
|
Refer to the links to the [Renovate Docs](https://docs.renovatebot.com/) for all options.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue