Skip to content

Commit 68a141d

Browse files
committed
docs: improve and fix lint issues
Signed-off-by: Emilien Escalle <[email protected]>
1 parent 185dfa9 commit 68a141d

File tree

4 files changed

+28
-14
lines changed

4 files changed

+28
-14
lines changed

.github/workflows/continuous-integration.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ on:
5555
description: |
5656
Whether to enable linting.
5757
Set to `null` or empty to disable.
58-
Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md).
58+
Accepts a JSON object for lint options. See [lint action](../../actions/lint/README.md).
5959
It should generate lint reports in standard formats.
6060
6161
Example:
@@ -87,7 +87,7 @@ on:
8787
description: |
8888
Whether to enable testing.
8989
Set to `null` or empty to disable.
90-
Accepts a JSON object for test options. See [test action](../actions/test/README.md).
90+
Accepts a JSON object for test options. See [test action](../../actions/test/README.md).
9191
If coverage is enabled, it should generate test and coverage reports in standard formats.
9292
9393
Example:

actions/build/action.yml

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,26 @@ inputs:
1515
build-commands:
1616
description: |
1717
List of build commands to execute, one per line.
18-
These are npm/pnpm/Yarn script names (e.g., "build", "compile").
18+
These are npm/pnpm/Yarn script names (e.g., `build`, `compile`).
1919
required: true
2020
build-env:
2121
description: |
2222
JSON object of environment variables to set during the build.
23-
Example: {"NODE_ENV": "production", "API_URL": "https://api.example.com"}
23+
Example:
24+
25+
```json
26+
{
27+
"NODE_ENV": "production",
28+
"API_URL": "https://api.example.com"
29+
}
30+
```
2431
required: false
2532
default: "{}"
2633
build-secrets:
2734
description: |
28-
Multi-line string of secrets in env format (KEY=VALUE).
35+
Multi-line string of secrets in env format (`KEY=VALUE`).
2936
Example:
30-
```
37+
```txt
3138
SECRET_KEY=$\{{ secrets.SECRET_KEY }}
3239
API_TOKEN=$\{{ secrets.API_TOKEN }}
3340
```
@@ -36,7 +43,14 @@ inputs:
3643
build-artifact:
3744
description: |
3845
JSON object specifying artifact upload configuration.
39-
Format: {"name": "artifact-name", "paths": "path1\npath2"}
46+
Example:
47+
48+
```json
49+
{
50+
"name": "artifact-name",
51+
"paths": "path1\npath2"
52+
}
53+
```
4054
required: false
4155
default: ""
4256
container:

actions/lint/action.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ inputs:
1818
default: "false"
1919
command:
2020
description: |
21-
NPM/package manager script command to run for linting.
22-
This should be a script defined in your package.json.
21+
npm/pnpm/Yarn script command to run for linting.
22+
This should be a script defined in your `package.json`.
2323
The command should generate lint report files in a standard format.
2424
required: false
2525
default: "lint:ci"
2626
report-file:
2727
description: |
2828
Optional lint report path forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action.
2929
Provide an absolute path or one relative to the working directory.
30-
When omitted, the action falls back to "auto:lint" detection.
30+
When omitted, the action falls back to `auto:lint` detection.
3131
required: false
3232
default: ""
3333
path-mapping:

actions/test/action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ inputs:
1818
default: "false"
1919
command:
2020
description: |
21-
NPM/package manager script command to run for testing.
22-
This should be a script defined in your package.json.
21+
npm/pnpm/Yarn script command to run for testing.
22+
This should be a script defined in your `package.json`.
2323
The command should generate coverage report files in a standard format (Cobertura XML, lcov, etc.).
2424
required: false
2525
default: "test:ci"
@@ -33,11 +33,11 @@ inputs:
3333
default: "github"
3434
report-file:
3535
description: |
36-
Optional test and coverage report paths forwarded to the hoverkraft-tech/ci-github-common/actions/parse-ci-reports action.
36+
Optional test and coverage report paths forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action.
3737
Supports multiple formats (Cobertura, OpenCover, lcov, etc.).
3838
Provide absolute paths or paths relative to the working directory.
3939
Multiple entries can be separated by newlines, commas, or semicolons.
40-
When omitted, the action falls back to "auto:test,auto:coverage" detection.
40+
When omitted, the action falls back to `auto:test,auto:coverage` detection.
4141
required: false
4242
default: ""
4343
path-mapping:

0 commit comments

Comments
 (0)