Skip to content

docs(hoverkraft-tech/ci-github-publish): update documentation #1256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Jun 30, 2026
Merged

docs(hoverkraft-tech/ci-github-publish): update documentation #1256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...rojects/github-actions-and-reusable-workflows/ci-github-publish/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
source_repo: hoverkraft-tech/ci-github-publish
source_path: CONTRIBUTING.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

# Contributing
Expand Down
4 changes: 2 additions & 2 deletions ...reusable-workflows/ci-github-publish/actions/argocd/get-manifest-files/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Get Manifest Files
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/argocd/get-manifest-files/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
14 changes: 7 additions & 7 deletions ...-and-reusable-workflows/ci-github-publish/actions/check/url-lighthouse/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Url Lighthouse
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/check/url-lighthouse/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down Expand Up @@ -69,12 +69,12 @@ The action always sends `User-Agent: hoverkraft-tech-url-lighthouse-action` when

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------- |
| **`url`** | The URL to audit using Lighthouse. | **true** | - |
| **Input** | **Description** | **Required** | **Default** |
| ------------------- | --------------------------------------------------------------------------------------------------------------- | ------------ | --------------- |
| **`url`** | The URL to audit using Lighthouse. | **true** | - |
| **`budget-path`** | The path to the performance budget file. See [https://web.dev/articles/use-lighthouse-for-performance-budgets](https://web.dev/articles/use-lighthouse-for-performance-budgets). | **false** | `./budget.json` |
| **`authorization`** | Optional Authorization header used to access private URLs. | **false** | - |
| | Example: `Bearer xxx...`, `token xxx...` | | |
| **`authorization`** | Optional Authorization header used to access private URLs. | **false** | - |
| | Example: `Bearer xxx...`, `token xxx...` | | |

<!-- inputs:end -->

Expand Down
4 changes: 2 additions & 2 deletions ...ctions-and-reusable-workflows/ci-github-publish/actions/check/url-ping/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Url Ping
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/check/url-ping/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
18 changes: 9 additions & 9 deletions ...e-workflows/ci-github-publish/actions/clean-deploy/repository-dispatch/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Repository Dispatch
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/clean-deploy/repository-dispatch/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down Expand Up @@ -77,14 +77,14 @@ See [https://docs.github.com/en/actions/writing-workflows/choosing-when-your-wor

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`github-token`** | GitHub Token for dispatch an event to a remote repository. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - contents: write | | |
| **Input** | **Description** | **Required** | **Default** |
| ------------------ | --------------------------------------------------------------- | ------------ | --------------------- |
| **`github-token`** | GitHub Token for dispatch an event to a remote repository. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - contents: write | | |
| | See [https://github.com/peter-evans/repository-dispatch#usage](https://github.com/peter-evans/repository-dispatch#usage). | | |
| **`repository`** | Target repository where the deployment should be cleaned. | **true** | - |
| **`environment`** | Environment where to clean the deployment. | **true** | - |
| **`repository`** | Target repository where the deployment should be cleaned. | **true** | - |
| **`environment`** | Environment where to clean the deployment. | **true** | - |

<!-- inputs:end -->

Expand Down
4 changes: 2 additions & 2 deletions ...sable-workflows/ci-github-publish/actions/deploy/argocd-manifest-files/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: ArgoCD Manifest Files
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/argocd-manifest-files/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
4 changes: 2 additions & 2 deletions ...nd-reusable-workflows/ci-github-publish/actions/deploy/get-environment/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Get Environment
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/get-environment/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
34 changes: 17 additions & 17 deletions ...s-and-reusable-workflows/ci-github-publish/actions/deploy/github-pages/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: GitHub Pages
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/github-pages/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down Expand Up @@ -96,21 +96,21 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`build-artifact-id`** | The ID of the "build" artifact to download. | **false** | - |
| | The artifact must contain the full (absolute) build path. | | |
| | If not set, the action will use the local workspace files. | | |
| **`build-path`** | The path to the assets to deploy. | **false** | - |
| | Can be absolute or relative $GITHUB_WORKSPACE. | | |
| **`budget-path`** | The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/index.md). | **false** | `./budget.json` |
| **`static-site-generator`** | The static site generator used to build the site. See [https://github.com/actions/configure-pages](https://github.com/actions/configure-pages). | **false** | - |
| **`checks`** | Whether to run URL checks after deployment. | **false** | `true` |
| **`github-token`** | GitHub Token for deploying to GitHub Pages. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - pages: write | | |
| | - id-token: write | | |
| | See [https://github.com/actions/deploy-pages](https://github.com/actions/deploy-pages). | | |
| **Input** | **Description** | **Required** | **Default** |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`build-artifact-id`** | The ID of the "build" artifact to download. | **false** | - |
| | The artifact must contain the full (absolute) build path. | | |
| | If not set, the action will use the local workspace files. | | |
| **`build-path`** | The path to the assets to deploy. | **false** | - |
| | Can be absolute or relative $GITHUB_WORKSPACE. | | |
| **`budget-path`** | The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/index.md). | **false** | `./budget.json` |
| **`static-site-generator`** | The static site generator used to build the site. See [https://github.com/actions/configure-pages](https://github.com/actions/configure-pages). | **false** | - |
| **`checks`** | Whether to run URL checks after deployment. | **false** | `true` |
| **`github-token`** | GitHub Token for deploying to GitHub Pages. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - pages: write | | |
| | - id-token: write | | |
| | See [https://github.com/actions/deploy-pages](https://github.com/actions/deploy-pages). | | |

<!-- inputs:end -->

Expand Down
6 changes: 3 additions & 3 deletions ...le-workflows/ci-github-publish/actions/deploy/helm-repository-dispatch/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Helm Repository Dispatch
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/helm-repository-dispatch/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down Expand Up @@ -114,7 +114,7 @@ See [https://docs.github.com/en/actions/writing-workflows/choosing-when-your-wor
| **`github-token`** | GitHub Token for dispatch an event to a remote repository. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - contents: write | | |
| | See [https://github.com/peter-evans/repository-dispatch#usage](https://github.com/peter-evans/repository-dispatch#usage). | | |
| | See [https://github.com/peter-evans/repository-dispatch#usage](https://github.com/peter-evans/repository-dispatch#usage). | | |
| **`initiated-by`** | Username to record as having initiated the sync operation | **true** | - |

<!-- inputs:end -->
Expand Down
4 changes: 2 additions & 2 deletions ...ctions-and-reusable-workflows/ci-github-publish/actions/deploy/jampack/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Jampack
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/jampack/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
4 changes: 2 additions & 2 deletions ...actions-and-reusable-workflows/ci-github-publish/actions/deploy/jekyll/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Jekyll
source_repo: hoverkraft-tech/ci-github-publish
source_path: actions/deploy/jekyll/README.md
source_branch: main
source_run_id: 27985182580
last_synced: 2026-06-22T21:33:27.954Z
source_run_id: 28471528368
last_synced: 2026-06-30T19:53:48.172Z
---

<!-- header:start -->
Expand Down
Loading
Loading