Skip to content

Commit a9a2bf2

Browse files
Prettier fixes applied automatically on 2025-01-18 13:43:00 UTC
1 parent 6f4b595 commit a9a2bf2

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It can either commit changes directly to the current branch or create a new bran
1212

1313
## Usage
1414

15-
This action is designed to be used as a *reusable workflow*. You can call it from another workflow in your repository or simply add [the provided YAML configuration](.github/workflows/phpcs-phpcbf.yml) to your repository.
15+
This action is designed to be used as a _reusable workflow_. You can call it from another workflow in your repository or simply add [the provided YAML configuration](.github/workflows/phpcs-phpcbf.yml) to your repository.
1616

1717
By default, if needed, a new branch with a name starting with `prettier/fix` will be created, making it easy to review and merge the fixes into your main branch.
1818

@@ -29,17 +29,17 @@ permissions:
2929
3030
### Inputs (all optional)
3131
32-
| Input | Description | Type | Default |
33-
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------ |
34-
| `commit-changes` | If set to `true`, the action will commit changes to the current branch; otherwise a new branch is created for manual review. | Boolean | `false` |
35-
| `commit-message` | Commit message to use if the action commits changes. | String | `"PHP Code Beautifier fixes applied automatically"` |
36-
| `extensions` | Comma-delimited list of file extensions to be sniffed. Note: an empty value will disable checking. | String | `"php"` (defaults to PHP only; other file types must be specified) |
37-
| `ignore` | Ignore files based on a comma-separated list of patterns matching files and/or directories. Default: `vendor/` | String |
38-
| `php-version` | The PHP version to use, e.g. `"8.2"`. | String | `"8.2"` |
39-
| `standard` | The name of, or the path to, the coding standard to use. Can be a comma-separated list specifying multiple standards. If not set, the project's `.github/linters/phpcs.xml` or <https://github.com/super-linter/super-linter/blob/main/TEMPLATES/phpcs.xml> copied to [.github/linters/super-linter-templates-phpcs.xml](.github/linters/super-linter-templates-phpcs.xml) will be used. | String |
32+
| Input | Description | Type | Default |
33+
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ |
34+
| `commit-changes` | If set to `true`, the action will commit changes to the current branch; otherwise a new branch is created for manual review. | Boolean | `false` |
35+
| `commit-message` | Commit message to use if the action commits changes. | String | `"PHP Code Beautifier fixes applied automatically"` |
36+
| `extensions` | Comma-delimited list of file extensions to be sniffed. Note: an empty value will disable checking. | String | `"php"` (defaults to PHP only; other file types must be specified) |
37+
| `ignore` | Ignore files based on a comma-separated list of patterns matching files and/or directories. Default: `vendor/` | String |
38+
| `php-version` | The PHP version to use, e.g. `"8.2"`. | String | `"8.2"` |
39+
| `standard` | The name of, or the path to, the coding standard to use. Can be a comma-separated list specifying multiple standards. If not set, the project's `.github/linters/phpcs.xml` or <https://github.com/super-linter/super-linter/blob/main/TEMPLATES/phpcs.xml> copied to [.github/linters/super-linter-templates-phpcs.xml](.github/linters/super-linter-templates-phpcs.xml) will be used. | String |
4040

4141
### Outputs
4242

43-
| Output | Description |
44-
| -------------- | ------------------------------------------------- |
45-
| `branch-name` | The name of the branch created/used |
43+
| Output | Description |
44+
| ------------- | ----------------------------------- |
45+
| `branch-name` | The name of the branch created/used |

0 commit comments

Comments
 (0)