Skip to content

Commit a662531

Browse files
committed
docs(deploy/github-pages): improve description for build-path regarding expected absolute path
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
1 parent e200699 commit a662531

2 files changed

Lines changed: 11 additions & 5 deletions

File tree

actions/deploy/github-pages/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,12 @@ permissions:
5050
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
5151
with:
5252
# The path to the assets to deploy.
53+
# When using a build artifact, it must exist in the artifact with its full path.
5354
# Can be absolute or relative $GITHUB_WORKSPACE.
5455
build-path: ""
5556

5657
# The ID of the "build" artifact to download.
58+
# The artifact must contain the full build path.
5759
# If not set, the action will use the local workspace files.
5860
build-artifact-id: ""
5961

@@ -88,8 +90,10 @@ permissions:
8890
| **Input** | **Description** | **Required** | **Default** |
8991
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
9092
| **`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. | | |
9194
| | Can be absolute or relative $GITHUB_WORKSPACE. | | |
9295
| **`build-artifact-id`** | The ID of the "build" artifact to download. | **false** | - |
96+
| | The artifact must contain the full build path. | | |
9397
| | If not set, the action will use the local workspace files. | | |
9498
| **`budget-path`** | The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/README.md). | **false** | `./budget.json` |
9599
| **`static-site-generator`** | The static site generator used to build the site. See <https://github.com/actions/configure-pages>. | **false** | - |

actions/deploy/github-pages/action.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ branding:
66
color: blue
77

88
inputs:
9-
build-path:
10-
description: |
11-
The path to the assets to deploy.
12-
Can be absolute or relative $GITHUB_WORKSPACE.
13-
required: false
149
build-artifact-id:
1510
description: |
1611
The ID of the "build" artifact to download.
12+
The artifact must contain the full (absolute) build path.
1713
If not set, the action will use the local workspace files.
14+
1815
required: false
1916
default: ""
17+
build-path:
18+
description: |
19+
The path to the assets to deploy.
20+
Can be absolute or relative $GITHUB_WORKSPACE.
21+
required: false
2022
budget-path:
2123
description: "The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/README.md)."
2224
required: false

0 commit comments

Comments
 (0)