Skip to content

Commit 4978017

Browse files
authored
Merge pull request #55 from bacciotti/issue_53
Issue 53 - Adding projects parameter to README.
2 parents ecb36a1 + c9936a1 commit 4978017

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Here the main important steps performed by **generate-data** action:
8282
| Field | Required | Default | Description |
8383
|--------------------|----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
8484
| github-token | true | | The Github token that must be used to interact with Github API |
85-
| definition-file | true | | The file containing all projects for which you want to provide the status, an [example](https://raw.githubusercontent.com/kiegroup/droolsjbpm-build-bootstrap/main/.ci/pull-request-config.yaml) - more infos [here](https://github.com/kiegroup/build-chain-configuration-reader) |
85+
| definition-file | true | | The file containing all projects for which you want to provide the status, an [example](https://raw.githubusercontent.com/kiegroup/droolsjbpm-build-bootstrap/main/.ci/pull-request-config.yaml) - more infos [here](https://github.com/kiegroup/build-chain-configuration-reader). Optional if the `projects` parameter is provided. |
8686
| title | false | Project status | The project/webapp title |
8787
| subtitle | false | Contribution status | The project/webapp subtitle |
8888
| base-branch-filter | false | | A comma separated list of base branches RegEx to be filtered. Like `main,7.59.x,8.x` or `main,^7.*` |
@@ -92,6 +92,7 @@ Here the main important steps performed by **generate-data** action:
9292
| logger-level | false | info | The log level. 'info' (default) \| 'trace' \| 'debug' |
9393
| gh-pages-branch | false | gh-pages | The branch used by `gh-pages` tool, where the webpage will be stored |
9494
| branches | false | [] | The list of branches for which to provide branches comparison |
95+
| projects | false | [] | The list of projects from which gather data. If provided, the `definition-file` parameter will be no more required. |
9596

9697
## Usage
9798

0 commit comments

Comments
 (0)