Skip to content

Commit e36fa79

Browse files
authored
docs(plugins/core): fix output_action description (lowlighter#1225)
1 parent 98bbeb4 commit e36fa79

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

.github/readme/partials/documentation/setup/action.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ From the `Developer settings` of your account settings, select `Personal access
2222

2323
No scopes are required, but additional one may be required depending on which features will be used. Each plugin documentation enumerates which scopes are required to make it work.
2424

25-
A a general rule, the following scopes may be required:
25+
As a general rule, the following scopes may be required:
2626
- `public_repo` for some plugins
2727
- `read:org` for all organizations related metrics
2828
- `repo` for all private repositories related metrics

source/plugins/core/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Or more granulary [at job or workflow level](https://docs.github.com/en/actions/
241241

242242
### Using commits (default)
243243

244-
Use `config_output: commit` to make the action directly push changes to `committer_branch` with a commit.
244+
Use `output_action: commit` to make the action directly push changes to `committer_branch` with a commit.
245245
A custom commit message can be used through `committer_message`.
246246

247247
> 💡 *metrics* will automatically ignore push events with a commit message containing `[Skip GitHub Action]` or `Auto-generated metrics for run #` to avoid infinite loops. Note that by default, GitHub already ignore events pushed by `${{ github.token }}` or containing `[skip ci]` in commit message
@@ -261,7 +261,7 @@ metrics:
261261

262262
### Using pull requests
263263

264-
Use `config_output: pull-request` to make the action open a new pull request and push changes from the same run on it.
264+
Use `output_action: pull-request` to make the action open a new pull request and push changes from the same run on it.
265265

266266
The last step should use either `pull-request-merge`, `pull-request-squash` or `pull-request-rebase` to merge changes to `committer_branch`.
267267

@@ -287,7 +287,7 @@ metrics:
287287

288288
### Using gists
289289

290-
Use `config_output: gist` to push output to a [GitHub gist](https://gist.github.com) instead.
290+
Use `output_action: gist` to push output to a [GitHub gist](https://gist.github.com) instead.
291291
It is required to provide a gist id to `committer_gist` option to make it work.
292292

293293
> 💡 This feature will use `token` instead of `committer_token` to push changes, so `gists` scope must be granted to the original `token` first
@@ -304,7 +304,7 @@ metrics:
304304

305305
### Manual handling
306306

307-
Use `config_output: none` to perform custom processing with outputs.
307+
Use `output_action: none` to perform custom processing with outputs.
308308
They will be available under `/metrics_renders/{filename}` in the runner.
309309

310310
*Example: generate outputs and manually push them*

0 commit comments

Comments
 (0)