Skip to content

Commit 54a081d

Browse files
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a662531 commit 54a081d

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

actions/deploy/github-pages/README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,17 @@ permissions:
4747
## Usage
4848
4949
```yaml
50-
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
50+
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@48e0c54489152b98d9e18f0454ccce120e9d0fd1 # 0.23.0
5151
with:
52-
# The path to the assets to deploy.
53-
# When using a build artifact, it must exist in the artifact with its full path.
54-
# Can be absolute or relative $GITHUB_WORKSPACE.
55-
build-path: ""
56-
5752
# The ID of the "build" artifact to download.
58-
# The artifact must contain the full build path.
53+
# The artifact must contain the full (absolute) build path.
5954
# If not set, the action will use the local workspace files.
6055
build-artifact-id: ""
6156

57+
# The path to the assets to deploy.
58+
# Can be absolute or relative $GITHUB_WORKSPACE.
59+
build-path: ""
60+
6261
# The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/README.md).
6362
# Default: `./budget.json`
6463
budget-path: ./budget.json
@@ -89,12 +88,11 @@ permissions:
8988
9089
| **Input** | **Description** | **Required** | **Default** |
9190
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
92-
| **`build-path`** | The path to the assets to deploy. | **false** | - |
93-
| | When using a build artifact, it must exist in the artifact with its full path. | | |
94-
| | Can be absolute or relative $GITHUB_WORKSPACE. | | |
9591
| **`build-artifact-id`** | The ID of the "build" artifact to download. | **false** | - |
96-
| | The artifact must contain the full build path. | | |
92+
| | The artifact must contain the full (absolute) build path. | | |
9793
| | If not set, the action will use the local workspace files. | | |
94+
| **`build-path`** | The path to the assets to deploy. | **false** | - |
95+
| | Can be absolute or relative $GITHUB_WORKSPACE. | | |
9896
| **`budget-path`** | The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/README.md). | **false** | `./budget.json` |
9997
| **`static-site-generator`** | The static site generator used to build the site. See <https://github.com/actions/configure-pages>. | **false** | - |
10098
| **`checks`** | Whether to run URL checks after deployment. | **false** | `true` |

0 commit comments

Comments
 (0)