diff --git a/.github/actions/generate-docs/__tests__/application-biome-formatter.test.js b/.github/actions/generate-docs/__tests__/application-biome-formatter.test.js new file mode 100644 index 00000000..fe02f4b5 --- /dev/null +++ b/.github/actions/generate-docs/__tests__/application-biome-formatter.test.js @@ -0,0 +1,37 @@ +import { describe, expect, it, vi } from "vitest"; + +process.env.GITHUB_REPOSITORY_OWNER ??= "hoverkraft-tech"; +process.env.GITHUB_REPOSITORY ??= "hoverkraft-tech/public-docs"; + +const { ApplicationBiomeFormatter } = await import( + "../lib/builders/application-biome-formatter.js" +); + +describe("ApplicationBiomeFormatter", () => { + it("runs biome check --write from the application root", async () => { + const exec = vi.fn().mockResolvedValue({ stdout: "", stderr: "" }); + const formatter = new ApplicationBiomeFormatter({ + applicationRoot: "/repo/application", + exec, + }); + + await formatter.format("/repo/application/src/pages/index.tsx"); + + expect(exec).toHaveBeenCalledWith( + "npm", + [ + "--prefix", + "/repo/application", + "exec", + "--", + "biome", + "check", + "--write", + "src/pages/index.tsx", + ], + { + cwd: "/repo/application", + }, + ); + }); +}); diff --git a/.github/actions/generate-docs/lib/builders/application-biome-formatter.js b/.github/actions/generate-docs/lib/builders/application-biome-formatter.js index 0a365aac..920dba6e 100644 --- a/.github/actions/generate-docs/lib/builders/application-biome-formatter.js +++ b/.github/actions/generate-docs/lib/builders/application-biome-formatter.js @@ -6,14 +6,18 @@ const { APPLICATION_ROOT } = require("../constants"); const execFileAsync = promisify(execFile); class ApplicationBiomeFormatter { - constructor({ applicationRoot = APPLICATION_ROOT } = {}) { + constructor({ + applicationRoot = APPLICATION_ROOT, + exec = execFileAsync, + } = {}) { this.applicationRoot = applicationRoot; + this.exec = exec; } async format(filePath) { const relativePath = path.relative(this.applicationRoot, filePath); - await execFileAsync( + await this.exec( "npm", [ "--prefix", @@ -21,7 +25,7 @@ class ApplicationBiomeFormatter { "exec", "--", "biome", - "format", + "check", "--write", relativePath, ], diff --git a/.github/workflows/__shared-ci.yml b/.github/workflows/__shared-ci.yml index a47e5ac1..6a8a285d 100644 --- a/.github/workflows/__shared-ci.yml +++ b/.github/workflows/__shared-ci.yml @@ -14,7 +14,7 @@ permissions: {} jobs: linter: - uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 permissions: actions: read contents: read diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 282345aa..6c9366df 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -10,7 +10,7 @@ permissions: {} jobs: greetings: - uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 permissions: contents: read issues: write diff --git a/.github/workflows/main-ci.yml b/.github/workflows/main-ci.yml index 9a0f139b..bbea1b0d 100644 --- a/.github/workflows/main-ci.yml +++ b/.github/workflows/main-ci.yml @@ -19,7 +19,7 @@ jobs: contents: write steps: - name: Checkout repository - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false @@ -29,7 +29,7 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} - id: generate-github-actions-docs - uses: hoverkraft-tech/ci-dokumentor@3258ef0de948ec25e5939618d5ef510445aed869 # 0.3.1 + uses: hoverkraft-tech/ci-dokumentor@301ef70a95e03b39e07ee0d3dc2da21de82e51ce # 0.4.0 with: source: | .github/actions/**/action.yml @@ -41,7 +41,7 @@ jobs: client-id: ${{ vars.CI_BOT_APP_CLIENT_ID }} private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env] - - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 with: github-token: ${{ steps.generate-token.outputs.token }} branch: docs/action-documentation-update @@ -81,7 +81,7 @@ jobs: url: ${{ steps.deployment.outputs.url }} steps: - id: deployment - uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@b2562b46714e535a0113f90f554b55e1248212c1 # 0.26.3 + uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@607069025f6c1312680ed0864c4d9f4338b82dfe # 0.26.5 with: build-path: application/build build-artifact-id: ${{ needs.ci.outputs.build-artifact-id }} diff --git a/.github/workflows/need-fix-to-issue.yml b/.github/workflows/need-fix-to-issue.yml index 4c0434c1..a56b4c6f 100644 --- a/.github/workflows/need-fix-to-issue.yml +++ b/.github/workflows/need-fix-to-issue.yml @@ -20,7 +20,7 @@ permissions: {} jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 permissions: contents: read issues: write diff --git a/.github/workflows/semantic-pull-request.yml b/.github/workflows/semantic-pull-request.yml index 7e2ba055..71820a45 100644 --- a/.github/workflows/semantic-pull-request.yml +++ b/.github/workflows/semantic-pull-request.yml @@ -11,7 +11,7 @@ permissions: {} jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 permissions: contents: write pull-requests: write diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 5e06c1aa..a14f3062 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -8,7 +8,7 @@ permissions: {} jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@624be17604ee0a7378488191aacb35851e7cf001 # 0.37.1 + uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 permissions: issues: write pull-requests: write diff --git a/.github/workflows/sync-docs-dispatcher.yml b/.github/workflows/sync-docs-dispatcher.yml index 8106a5f7..0b6c1b5b 100644 --- a/.github/workflows/sync-docs-dispatcher.yml +++ b/.github/workflows/sync-docs-dispatcher.yml @@ -34,7 +34,7 @@ jobs: contents: read steps: - name: Checkout repository - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false diff --git a/.github/workflows/sync-docs-receiver.yml b/.github/workflows/sync-docs-receiver.yml index f633ecc4..dfb16838 100644 --- a/.github/workflows/sync-docs-receiver.yml +++ b/.github/workflows/sync-docs-receiver.yml @@ -15,7 +15,7 @@ jobs: pull-requests: write steps: - name: Checkout repository - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false @@ -93,7 +93,7 @@ jobs: client-id: ${{ vars.CI_BOT_APP_CLIENT_ID }} private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env] - - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@624be17604ee0a7378488191aacb35851e7cf001 # 0.30.21 + - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.30.21 with: github-token: ${{ steps.generate_token.outputs.token }} branch: docs/sync-documentation-${{ github.event.client_payload.repository }} diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md index f486f9fe..1450f7b2 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md @@ -186,39 +186,39 @@ permissions: | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: | | | | | `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **true** | `${{ github.token }}` | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | | | | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`repository`** | Repository name. | **false** | `${{ github.repository }}` | | | Example: `my-org/my-repo`. | | | -| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | +| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | | **`image`** | Additional image name. | **false** | - | | | Example: `application`. | | | -| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | +| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | | **`tag`** | Force image tag to publish | **false** | - | | **`platform`** | Platform to build for. Example: `linux/amd64`. | **true** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`context`** | Build's context is the set of files located in the specified PATH or URL. | **false** | `.` | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`dockerfile`** | Location of Dockerfile (defaults to Dockerfile). | **false** | `Dockerfile` | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`build-args`** | List of build-time variables. | **false** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`target`** | Sets the target stage to build. | **false** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`secrets`** | List of secrets to expose to the build. | **false** | - | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | | **`secret-envs`** | List of secret environment variables to expose to the build (e.g., `key=envname, MY_SECRET=MY_ENV_VAR`). | **false** | - | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | | **`cache-type`** | Cache type. Set to `false` or empty to disable cache entirely. | **false** | `gha` | | | For `gha`, cache restore remains enabled on untrusted default-branch-scoped triggers, | | | | | but cache export is skipped automatically because GitHub only grants read-only cache access there. | | | -| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | +| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | Example for insecure registry: | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | **`multi-platform`** | Whether this build participates in a multi-platform image publication. | **false** | `false` | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md index b673b552..b79dc50b 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md @@ -82,13 +82,13 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | -| **`package`** | Comma-separated list of packages to cleanup. | **true** | - | -| | Example: "application-1,application-2" | | | -| **`tags`** | Comma-separated list of tags to delete (supports wildcard syntax). | **true** | - | -| | Example: `pr-*,dev` | | | -| **`github-token`** | GitHub token with the packages:write and packages:delete scopes. | **false** | `${{ github.token }}` | +| **Input** | **Description** | **Required** | **Default** | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | +| **`package`** | Comma-separated list of packages to cleanup. | **true** | - | +| | Example: "application-1,application-2" | | | +| **`tags`** | Comma-separated list of tags to delete (supports wildcard syntax). | **true** | - | +| | Example: `pr-*,dev` | | | +| **`github-token`** | GitHub token with the packages:write and packages:delete scopes. | **false** | `${{ github.token }}` | | | See [https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries](https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md index 113e3c63..2da71b1c 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md @@ -137,12 +137,12 @@ permissions: | **`oci-registry-username`** | Username configuration used to log against OCI registries. | **true** | `${{ github.repository_owner }}` | | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **true** | `${{ github.token }}` | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | | | | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`built-images`** | Built images data. | **true** | - | | | Example: | | | | | 
{
 "application": {
 "name": "application",
 "registry": "ghcr.io",
 "repository": "my-org/my-repo/application",
 "tags": ["pr-63-5222075","pr-63"],
 "images": [
 "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",
 "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402",
 ],
 "annotations": {
 "org.opencontainers.image.created": "2021-09-30T14:00:00Z",
 "org.opencontainers.image.description": "Application image"
 },
 "platforms": ["linux/amd64", "linux/arm64"],
 "multi-platform": true
 }
}
| | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md index d6fa3d07..b95af6f7 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md @@ -69,12 +69,12 @@ It uses the [docker/metadata-action](https://github.com/docker/metadata-action) ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------ | -------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------- | -| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` | +| **Input** | **Description** | **Required** | **Default** | +| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------- | +| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` | | **`repository`** | Repository name. Example: `my-org/my-repo`. See [Docker get-image-name action](../get-image-name/index.md) | **false** | `${{ github.repository }}` | | **`image`** | Additional image name. Example: `application`. See [Docker get-image-name action](../get-image-name/index.md) | **false** | - | -| **`tag`** | Force image tag to publish | **false** | - | +| **`tag`** | Force image tag to publish | **false** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md index c54ad076..bfdf43a8 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md @@ -81,14 +81,14 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- | -| **`image`** | Image name | **false** | - | -| **`pull-request-tag-filter`** | The regular expression to match pull request tags. Must have a capture group for the pull request number. | **false** | `^pr-([0-9]+)(?:-\|$)` | -| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | - | -| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | -| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | -| **`github-token`** | GitHub token with the following scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `${{ github.token }}` | +| **Input** | **Description** | **Required** | **Default** | +| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- | +| **`image`** | Image name | **false** | - | +| **`pull-request-tag-filter`** | The regular expression to match pull request tags. Must have a capture group for the pull request number. | **false** | `^pr-([0-9]+)(?:-\|$)` | +| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | - | +| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | +| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | +| **`github-token`** | GitHub token with the following scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `${{ github.token }}` | | | See [https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries](https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md index 592762f0..7c90e24f 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md @@ -108,7 +108,7 @@ Shared action to configure Docker tooling and OCI registry authentication. | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **false** | - | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | Example for insecure registry: | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | **`built-images`** | Optional built images payload used to resolve manifest publication registries. | **false** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md index fbfb4a78..ed5f1743 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md @@ -85,22 +85,22 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| -------------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- | -| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | -| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | -| | Can be a branch, tag or commit SHA. | | | -| | Set to an empty string to skip checkout. | | | -| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | -| | See [https://github.com/losisin/helm-values-schema-json-action](https://github.com/losisin/helm-values-schema-json-action). | | | -| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - contents: write | | | -| | - pull-requests: write | | | -| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | +| **Input** | **Description** | **Required** | **Default** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------- | +| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | +| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | +| | Can be a branch, tag or commit SHA. | | | +| | Set to an empty string to skip checkout. | | | +| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | +| | See [https://github.com/losisin/helm-values-schema-json-action](https://github.com/losisin/helm-values-schema-json-action). | | | +| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - contents: write | | | +| | - pull-requests: write | | | +| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md index aece61fa..e37ab9ae 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md @@ -61,11 +61,11 @@ for all charts found under a path. ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ----------------------- | -------------------------------------------------------------------- | ------------ | ----------- | -| **`path`** | Path containing the chart(s) to prepare | **true** | - | -| **`helm-repositories`** | List of Helm repositories to add before building chart dependencies. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | ----------------------------------------------------------------------------------------- | ------------ | ----------- | +| **`path`** | Path containing the chart(s) to prepare | **true** | - | +| **`helm-repositories`** | List of Helm repositories to add before building chart dependencies. | **false** | - | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md index 195a9201..7e9c4b63 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md @@ -127,22 +127,22 @@ This action requires the following permissions on the repository: | **Input** | **Description** | **Required** | **Default** | | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | | **`oci-registry`** | OCI registry where to push chart. | **true** | `ghcr.io` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`oci-registry-username`** | OCI registry username. | **true** | `${{ github.repository_owner }}` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`oci-registry-password`** | OCI registry password. | **true** | `${{ github.token }}` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`chart`** | Chart name to release | **true** | - | | **`path`** | Path to the chart to release | **true** | - | | **`values`** | Define charts values to be filled. | **false** | - | -| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | +| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | | | Format: `[{ file, path, value }]`. | | | | | | | | | | Example: | | | | | | | | | | 
[
 {
 "file": "charts/application/charts/api/values.yaml",
 "path": ".image.registry", "value": "ghcr.io"
 }
]
| | | | **`helm-repositories`** | List of Helm repositories to add before release charts. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | | **`tag`** | The release tag to set to chart | **true** | - | | **`update-tag-paths`** | List of YAML paths to update with the tag. | **false** | `.version,.appVersion` | | | Comma separated list of paths. | | | @@ -158,10 +158,10 @@ This action requires the following permissions on the repository: ## Outputs -| **Output** | **Description** | -| ----------- | -------------------------------------------------------------- | -| **`image`** | Chart image (Format: `{registry}/{repository}/{image}:{tag}`). | -| | See [https://github.com/appany/helm-oci-chart-releaser](https://github.com/appany/helm-oci-chart-releaser). | +| **Output** | **Description** | +| ----------- | ----------------------------------------------------------------------------------------------------------- | +| **`image`** | Chart image (Format: `{registry}/{repository}/{image}:{tag}`). | +| | See [https://github.com/appany/helm-oci-chart-releaser](https://github.com/appany/helm-oci-chart-releaser). | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md index 2e820525..b51a831f 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md @@ -104,26 +104,26 @@ Mainly using [helm/chart-testing-action](https://github.com/helm/chart-testing-a ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| --------------------------- | --------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | -| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | -| **`helm-set`** | Set values for Helm chart. | **false** | - | -| | Multiple values can be set using multiline string. | | | -| | Example: | | | -| | 
key1=value1
key2=value2
| | | -| **`helm-repositories`** | List of Helm repositories to add before testing charts. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | -| **`oci-registry`** | OCI registry where to pull and push images | **false** | `ghcr.io` | -| **`oci-registry-username`** | Username used to log against the OCI registry. | **false** | `${{ github.repository_owner }}` | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | -| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **false** | `${{ github.token }}` | -| | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | -| **`check-diff-only`** | Only run lint and tests on changed charts. | **false** | `true` | -| **`enable-lint`** | Enable linting of the Helm chart. | **false** | `true` | -| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md](https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md). | | | -| **`enable-install`** | Enable installing the Helm chart. | **false** | `true` | -| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_install.md](https://github.com/helm/chart-testing/blob/main/doc/ct_install.md). | | | +| **Input** | **Description** | **Required** | **Default** | +| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | +| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | +| **`helm-set`** | Set values for Helm chart. | **false** | - | +| | Multiple values can be set using multiline string. | | | +| | Example: | | | +| | 
key1=value1
key2=value2
| | | +| **`helm-repositories`** | List of Helm repositories to add before testing charts. | **false** | - | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| **`oci-registry`** | OCI registry where to pull and push images | **false** | `ghcr.io` | +| **`oci-registry-username`** | Username used to log against the OCI registry. | **false** | `${{ github.repository_owner }}` | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **false** | `${{ github.token }}` | +| | Can be passed in using `secrets.GITHUB_TOKEN`. | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| **`check-diff-only`** | Only run lint and tests on changed charts. | **false** | `true` | +| **`enable-lint`** | Enable linting of the Helm chart. | **false** | `true` | +| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md](https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md). | | | +| **`enable-install`** | Enable installing the Helm chart. | **false** | `true` | +| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_install.md](https://github.com/helm/chart-testing/blob/main/doc/ct_install.md). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md index 86724121..1013020c 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md @@ -76,7 +76,7 @@ Updates Helm chart values files before release. | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | | **`path`** | Path to the chart to update | **true** | - | | **`values`** | Define charts values to be filled. | **false** | - | -| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | +| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | | | Format: `[{ file, path, value }]`. | | | | | | | | | | Example: | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md index e930decb..8f74ca5d 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md @@ -201,7 +201,7 @@ jobs: | **Input** | **Description** | **Required** | **Type** | **Default** | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | -------------------------------- | | **`runs-on`** | Runner to use. JSON array of runners. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | | **`oci-registry`** | OCI registry configuration used to pull, push and cache images. | **false** | **string** | `ghcr.io` | | | Accepts either a registry hostname string (default format) or a JSON object. | | | | | | JSON example: `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}` | | | | @@ -214,29 +214,29 @@ jobs: | **`oci-registry-username`** | Username configuration used to log against OCI registries. | **false** | **string** | `${{ github.repository_owner }}` | | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | | JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | | **`images`** | Images to build parameters. | **true** | **string** | - | | | JSON array of objects. | | | | | | Example: | | | | | | 
[
 {
 "name": "application",
 "context": ".",
 "dockerfile": "./docker/application/Dockerfile",
 "target": "prod",
 "build-args": {
 "APP_PATH": "./application/",
 "PROD_MODE": "true"
 },
 "secret-envs": {
 "GH_TOKEN": "GITHUB_TOKEN"
 },
 "platforms": [
 "linux/amd64",
 {
 "name": "darwin/amd64",
 "runs-on": "macos-latest"
 }
 ]
 }
]
| | | | | **`lfs`** | Enable Git LFS. | **false** | **boolean** | `true` | -| | See [https://github.com/actions/checkout?tab=readme-ov-file#usage](https://github.com/actions/checkout?tab=readme-ov-file#usage). | | | | +| | See [https://github.com/actions/checkout?tab=readme-ov-file#usage](https://github.com/actions/checkout?tab=readme-ov-file#usage). | | | | | **`build-secret-github-app-token-env`** | Environment variable name(s) to pass GitHub token generated by GitHub App. | **false** | **string** | `GITHUB_APP_TOKEN` | | | Can be a multiline string list. | | | | | | This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs. | | | | | | Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`. | | | | | **`build-secret-github-app-client-id`** | GitHub App client ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | | **`build-secret-github-app-owner`** | The owner of the GitHub App installation. | **false** | **string** | `${{ github.repository_owner }}` | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | | **`cache-type`** | Cache type. Set to `false` or empty to disable cache entirely. | **false** | **string** | `gha` | -| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | +| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | **string** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | | Example for insecure registry: | | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | | **`sign`** | Sign built images. | **false** | **boolean** | `true` | -| | See [sign-images](../../actions/docker/sign-images/index.md). | | | | +| | See [sign-images](../../actions/docker/sign-images/index.md). | | | | @@ -244,16 +244,16 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------ | -| **`oci-registry-password`** | Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries. | **true** | -| | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | -| | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | -| **`build-secrets`** | List of secrets to expose to the build. | **false** | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | -| **`build-secret-github-app-key`** | GitHub App private key to generate GitHub token to be passed as build secret env. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`oci-registry-password`** | Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries. | **true** | +| | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | +| | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | +| **`build-secrets`** | List of secrets to expose to the build. | **false** | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | +| **`build-secret-github-app-key`** | GitHub App private key to generate GitHub token to be passed as build secret env. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | @@ -289,8 +289,8 @@ Optional pull registries without credentials are skipped, which is useful for pu ### Images entry parameters -| **Parameter** | **Description** | **Default** | **Required** | -| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------ | +| **Parameter** | **Description** | **Default** | **Required** | +| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------ | | **name** | Image name. Must be unique. It is used as `image` in [Docker build-image action](../../actions/docker/build-image/index.md) | | **true** | | **repository** | Repository name. See [Docker build-image action](../../actions/docker/build-image/index.md) | | **false** | | **context** | Build context. See [Docker build-image action](../../actions/docker/build-image/index.md) | . | **false** | @@ -302,9 +302,9 @@ Optional pull registries without credentials are skipped, which is useful for pu #### Platforms entry parameters -| **Parameter** | **Description** | **Default** | **Required** | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------- | ----------- | ------------ | -| **name** | Platform name. Example: `linux/amd64` | | **true** | +| **Parameter** | **Description** | **Default** | **Required** | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ | +| **name** | Platform name. Example: `linux/amd64` | | **true** | | **runs-on** | JSON array of runner(s) to use. See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job) | | **false** | ##### Default `runs-on` strategy diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md index 0bca6124..3521d681 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md @@ -100,20 +100,20 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`images`** | Images to clean. | **true** | **string** | - | -| | Example: | | | | -| | 
 ["application-1","application-2"]
| | | | -| **`prune-cache-images`** | Prune cache image tags (like `application-1/cache`). | **false** | **boolean** | `false` | -| | Useful when building image with "registry" cache backend. | | | | -| **`pull-request-tag-filter`** | The regular expression to match pull request tags. | **false** | **string** | `^pr-([0-9]+)(?:-\|$)` | -| | Must have a capture group for the pull request number. | | | | -| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | **string** | - | -| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | | -| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`images`** | Images to clean. | **true** | **string** | - | +| | Example: | | | | +| | 
 ["application-1","application-2"]
| | | | +| **`prune-cache-images`** | Prune cache image tags (like `application-1/cache`). | **false** | **boolean** | `false` | +| | Useful when building image with "registry" cache backend. | | | | +| **`pull-request-tag-filter`** | The regular expression to match pull request tags. | **false** | **string** | `^pr-([0-9]+)(?:-\|$)` | +| | Must have a capture group for the pull request number. | | | | +| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | **string** | - | +| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | | +| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/check/url-lighthouse/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/check/url-lighthouse/index.md index 088bee2e..58e4bc6d 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/check/url-lighthouse/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/check/url-lighthouse/index.md @@ -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...` | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/clean-deploy/repository-dispatch/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/clean-deploy/repository-dispatch/index.md index e8547a74..17ae12e4 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/clean-deploy/repository-dispatch/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/clean-deploy/repository-dispatch/index.md @@ -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** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/github-pages/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/github-pages/index.md index 13a79fd5..d9133f69 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/github-pages/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/github-pages/index.md @@ -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). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/helm-repository-dispatch/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/helm-repository-dispatch/index.md index 5044df8e..468e4ec3 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/helm-repository-dispatch/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/helm-repository-dispatch/index.md @@ -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** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/report/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/report/index.md index 3f3d0879..6ed18251 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/report/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deploy/report/index.md @@ -108,19 +108,19 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------- | ------------------------------------------------------------------------------------------------------------ | ------------ | ------------------------------------- | -| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | -| **`deployment-id`** | Deployment ID to report. | **false** | - | -| **`environment`** | Environment where the deployment was made. | **false** | - | -| **`url`** | URL where the deployment is available. | **false** | - | -| **`extra`** | Extra outputs to be included in the summary. JSON object with key-value pairs. | **false** | - | -| **`github-token`** | GitHub Token to update the deployment. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - actions: read | | | -| | - deployments: write | | | -| | - issues: write | | | -| | - pull-requests: write | | | +| **Input** | **Description** | **Required** | **Default** | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------- | +| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | +| **`deployment-id`** | Deployment ID to report. | **false** | - | +| **`environment`** | Environment where the deployment was made. | **false** | - | +| **`url`** | URL where the deployment is available. | **false** | - | +| **`extra`** | Extra outputs to be included in the summary. JSON object with key-value pairs. | **false** | - | +| **`github-token`** | GitHub Token to update the deployment. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - actions: read | | | +| | - deployments: write | | | +| | - issues: write | | | +| | - pull-requests: write | | | | | See [https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status](https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/read/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/read/index.md index 35a33711..7f24184d 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/read/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/read/index.md @@ -72,13 +72,13 @@ Action to retrieve some deployment information. ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------- | ----------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------- | -| **`deployment-id`** | The ID of the deployment to update | **true** | - | -| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | -| **`github-token`** | GitHub Token to get the deployment information. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - deployments: read | | | +| **Input** | **Description** | **Required** | **Default** | +| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------- | +| **`deployment-id`** | The ID of the deployment to update | **true** | - | +| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | +| **`github-token`** | GitHub Token to get the deployment information. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - deployments: read | | | | | See [https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#get-a-deployment](https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#get-a-deployment). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/update/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/update/index.md index 250977a2..6f1ad789 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/update/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/deployment/update/index.md @@ -97,18 +97,18 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------ | ------------------------------------- | -| **`deployment-id`** | The ID of the deployment to update | **true** | - | -| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | -| **`state`** | The state of the deployment | **true** | - | -| **`description`** | The description of the deployment | **false** | - | -| **`url`** | The URL of the deployment | **false** | - | -| **`update-log-url`** | Update the log URL of the deployment | **false** | `true` | -| **`github-token`** | GitHub Token to update the deployment. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - actions: read | | | -| | - deployments: write | | | +| **Input** | **Description** | **Required** | **Default** | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------- | +| **`deployment-id`** | The ID of the deployment to update | **true** | - | +| **`repository`** | The repository where the deployment was made | **false** | `${{ github.event.repository.name }}` | +| **`state`** | The state of the deployment | **true** | - | +| **`description`** | The description of the deployment | **false** | - | +| **`url`** | The URL of the deployment | **false** | - | +| **`update-log-url`** | Update the log URL of the deployment | **false** | `true` | +| **`github-token`** | GitHub Token to update the deployment. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - actions: read | | | +| | - deployments: write | | | | | See [https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status](https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/release/create/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/release/create/index.md index 0c8bc44a..22fccf15 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/release/create/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/release/create/index.md @@ -152,7 +152,7 @@ The release is published by default after optional changelog summarization and a | | - workingDirectory (optional, default: `working-directory` input or `.`) | | | | | - summaryTemplate (optional template forwarded to `release/summarize-changelog`) | | | | | | | | -| | See: [`release/summarize-changelog` action inputs](../summarize-changelog/index.md) for details on the summarization configuration. | | | +| | See: [`release/summarize-changelog` action inputs](../summarize-changelog/index.md) for details on the summarization configuration. | | | | | | | | | | Example value: | | | | | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/workflow/get-workflow-failure/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/workflow/get-workflow-failure/index.md index ec680b30..9873542a 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/workflow/get-workflow-failure/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/actions/workflow/get-workflow-failure/index.md @@ -74,11 +74,11 @@ It requires the `actions: read` permission on the token used. ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------ | ------------------------------------------------------------------------------------- | ------------ | --------------------- | -| **`github-token`** | GitHub Token to get workflow information. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - actions: read | | | +| **Input** | **Description** | **Required** | **Default** | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | +| **`github-token`** | GitHub Token to get workflow information. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - actions: read | | | | | See [https://docs.github.com/en/rest/actions/workflows#list-jobs-for-a-workflow-run](https://docs.github.com/en/rest/actions/workflows#list-jobs-for-a-workflow-run). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy-argocd-app-of-apps.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy-argocd-app-of-apps.md index 19bff670..d8a4755d 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy-argocd-app-of-apps.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy-argocd-app-of-apps.md @@ -104,12 +104,12 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | @@ -120,12 +120,12 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------ | -| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | -| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | +| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy.md index 7a98ec3c..98a6501b 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/clean-deploy.md @@ -129,21 +129,21 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | --------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | -| **`clean-deploy-type`** | Type of clean-deploy action. | **false** | **string** | `repository-dispatch` | -| | Supported values: | | | | -| | - [`repository-dispatch`](../../actions/clean-deploy/repository-dispatch/index.md). | | | | -| **`clean-deploy-parameters`** | Inputs to pass to the clean action. | **false** | **string** | - | -| | JSON object, depending on the clean-deploy-type. | | | | -| | For example, for `repository-dispatch`: | | | | -| | 
{
 "repository": "my-org/my-repo"
}
| | | | -| **`trigger-on-comment`** | Comment trigger to start the workflow. | **false** | **string** | `/undeploy` | -| | See [https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment). | | | | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | --------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`clean-deploy-type`** | Type of clean-deploy action. | **false** | **string** | `repository-dispatch` | +| | Supported values: | | | | +| | - [`repository-dispatch`](../../actions/clean-deploy/repository-dispatch/index.md). | | | | +| **`clean-deploy-parameters`** | Inputs to pass to the clean action. | **false** | **string** | - | +| | JSON object, depending on the clean-deploy-type. | | | | +| | For example, for `repository-dispatch`: | | | | +| | 
{
 "repository": "my-org/my-repo"
}
| | | | +| **`trigger-on-comment`** | Comment trigger to start the workflow. | **false** | **string** | `/undeploy` | +| | See [https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment). | | | | @@ -151,13 +151,13 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| -------------------- | ------------------------------------------------------------------------- | ------------ | -| **`github-token`** | GitHub token for deploying. | **false** | -| | Permissions: | | -| | - contents: write | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| -------------------- | ------------------------------------------------------------------------------------------------------------- | ------------ | +| **`github-token`** | GitHub token for deploying. | **false** | +| | Permissions: | | +| | - contents: write | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-argocd-app-of-apps.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-argocd-app-of-apps.md index b6325907..0b15dccc 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-argocd-app-of-apps.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-argocd-app-of-apps.md @@ -139,13 +139,13 @@ on: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`template-filename`** | Filename of the template to use. | **false** | **string** | `template.yml.tpl` | -| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`template-filename`** | Filename of the template to use. | **false** | **string** | `template.yml.tpl` | +| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | @@ -153,12 +153,12 @@ on: ## Secrets -| **Secret** | **Description** | **Required** | -| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------ | -| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | -| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | +| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-chart.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-chart.md index 130faf44..ae79c766 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-chart.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-chart.md @@ -251,7 +251,7 @@ jobs: | **Input** | **Description** | **Required** | **Type** | **Default** | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | -------------------------- | | **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | | **`environment`** | Destination where to deploy given chart. | **true** | **string** | - | | | Can be an environment name or an environment name with a dynamic identifier. | | | | | | Example: `review-apps:pr-1234`. | | | | @@ -264,7 +264,7 @@ jobs: | | Example: `https://{{ identifier }}.my-application.com`. | | | | | **`deploy-type`** | Type of deployment to perform. | **false** | **string** | `helm-repository-dispatch` | | | Supported values: | | | | -| | - [`helm-repository-dispatch`](../../actions/deploy/helm-repository-dispatch/index.md). | | | | +| | - [`helm-repository-dispatch`](../../actions/deploy/helm-repository-dispatch/index.md). | | | | | **`deploy-parameters`** | Inputs to pass to the deployment action. | **false** | **string** | - | | | JSON object, depending on the deploy-type. | | | | | | For example, for `helm-repository-dispatch`: | | | | @@ -273,9 +273,9 @@ jobs: | **`oci-registry-username`** | Username configuration used to log against OCI registries for the image build. | **false** | **string** | - | | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | | Defaults to the repository owner when not set. | | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | | **`images`** | Images to build parameters. | **true** | **string** | - | -| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/.github/workflows/docker-build-images.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/.github/workflows/docker-build-images.md). | | | | +| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/.github/workflows/docker-build-images.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/.github/workflows/docker-build-images.md). | | | | | **`build-parameters`** | Additional parameters forwarded to the image build workflow. | **false** | **string** | `{}` | | | JSON object using the image build workflow input names as keys. | | | | | | Supported keys: | | | | @@ -289,11 +289,11 @@ jobs: | | Example: | | | | | | 
{
 "cache-type": "registry",
 "sign": false,
 "buildkitd-config-inline": "[registry.\"my-registry.local:5000\"]\nhttp = true\ninsecure = true"
}
| | | | | **`chart-name`** | Chart name to release. | **false** | **string** | `application` | -| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | +| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | | **`chart-path`** | Path to the chart to release. | **false** | **string** | `charts/application` | -| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | +| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | | **`chart-values`** | Define chart values to be filled. | **false** | **string** | `[]` | -| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | +| | See [https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md](https://github.com/hoverkraft-tech/ci-github-container/blob/main/actions/helm/release-chart/README.md). | | | | | | Accept placeholders: | | | | | | - `{{ tag }}`: will be replaced by the tag. | | | | | | - `{{ url }}`: will be replaced by the URL. | | | | @@ -301,7 +301,7 @@ jobs: | | Example: | | | | | | 
[
 { "path": ".image", "image": "application" },
 { "path": ".application.version", "value": "{{ tag }}" },
 { "path": "deploy.ingress.hosts[0].host", "value": "{{ url }}" }
]
| | | | | **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | @@ -309,18 +309,18 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| --------------------------------- | ----------------------------------------------------------------------------------------- | ------------ | -| **`oci-registry-password`** | OCI registry password. | **true** | -| **`build-secrets`** | List of secrets to expose to the build. | **false** | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | -| **`build-secret-github-app-key`** | GitHub App private key to generate a token to be passed to the image build as secret env. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | -| **`github-token`** | GitHub token for deploying. | **false** | -| | Permissions: | | -| | - contents: write | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`oci-registry-password`** | OCI registry password. | **true** | +| **`build-secrets`** | List of secrets to expose to the build. | **false** | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | +| **`build-secret-github-app-key`** | GitHub App private key to generate a token to be passed to the image build as secret env. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **`github-token`** | GitHub token for deploying. | **false** | +| | Permissions: | | +| | - contents: write | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-checks.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-checks.md index 3c7848b9..933bf072 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-checks.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-checks.md @@ -98,16 +98,16 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ------------------- | ---------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`url`** | The URL to check. | **true** | **string** | - | -| **`budget-path`** | Path to the budget file to use for the Lighthouse check. | **false** | **string** | `./budget.json` | -| | See [`url-lighthouse`](../../actions/check/url-lighthouse/index.md). | | | | -| **`ping-timeout`** | Timeout in seconds for the URL ping check. | **false** | **string** | `60` | -| | See [`url-ping`](../../actions/check/url-ping/index.md). | | | | -| **`print-summary`** | Whether to print a summary of the checks. | **false** | **boolean** | `true` | +| **`url`** | The URL to check. | **true** | **string** | - | +| **`budget-path`** | Path to the budget file to use for the Lighthouse check. | **false** | **string** | `./budget.json` | +| | See [`url-lighthouse`](../../actions/check/url-lighthouse/index.md). | | | | +| **`ping-timeout`** | Timeout in seconds for the URL ping check. | **false** | **string** | `60` | +| | See [`url-ping`](../../actions/check/url-ping/index.md). | | | | +| **`print-summary`** | Whether to print a summary of the checks. | **false** | **boolean** | `true` | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-finish.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-finish.md index 73ffdec6..6166eba3 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-finish.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-finish.md @@ -121,20 +121,20 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ------------------------ | ----------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`deployment-id`** | Deployment ID to use for the deployment. | **true** | **string** | - | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`deployment-id`** | Deployment ID to use for the deployment. | **true** | **string** | - | | | See [https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#list-deployments](https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#list-deployments). | | | | -| **`budget-path`** | Path to the budget file to use for the Lighthouse check. | **false** | **string** | `./budget.json` | -| | See [`url-lighthouse`](../../actions/check/url-lighthouse/index.md). | | | | -| **`deployment-timeout`** | Maximum time to wait for the deployment to reach a terminal state, in seconds. | **false** | **string** | `300` | -| | See [`get-finished`](../../actions/deployment/get-finished/index.md). | | | | -| **`ping-timeout`** | Timeout in seconds for the URL ping check. | **false** | **string** | `60` | -| | See [`url-ping`](../../actions/check/url-ping/index.md). | | | | -| **`extra`** | Extra information to send to the deployment summary. | **false** | **string** | - | -| | Should be a JSON object. | | | | +| **`budget-path`** | Path to the budget file to use for the Lighthouse check. | **false** | **string** | `./budget.json` | +| | See [`url-lighthouse`](../../actions/check/url-lighthouse/index.md). | | | | +| **`deployment-timeout`** | Maximum time to wait for the deployment to reach a terminal state, in seconds. | **false** | **string** | `300` | +| | See [`get-finished`](../../actions/deployment/get-finished/index.md). | | | | +| **`ping-timeout`** | Timeout in seconds for the URL ping check. | **false** | **string** | `60` | +| | See [`url-ping`](../../actions/check/url-ping/index.md). | | | | +| **`extra`** | Extra information to send to the deployment summary. | **false** | **string** | - | +| | Should be a JSON object. | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-start.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-start.md index 55b896d1..6f38198e 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-start.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/deploy-start.md @@ -111,15 +111,15 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`environment`** | Environment where to deploy. | **false** | **string** | - | -| | If trigger is from an issue event (or pull-request), environment will be set to `environment:issue_number`. | | | | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`environment`** | Environment where to deploy. | **false** | **string** | - | +| | If trigger is from an issue event (or pull-request), environment will be set to `environment:issue_number`. | | | | | | See [https://docs.github.com/en/actions/deployment/deploying-to-your-cloud-provider/using-environments-for-deployment](https://docs.github.com/en/actions/deployment/deploying-to-your-cloud-provider/using-environments-for-deployment). | | | | -| **`trigger-on-comment`** | Comment trigger to start the workflow. | **false** | **string** | `/deploy` | -| | See [https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment). | | | | +| **`trigger-on-comment`** | Comment trigger to start the workflow. | **false** | **string** | `/deploy` | +| | See [https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment). | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/finish-deploy-argocd-app-of-apps.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/finish-deploy-argocd-app-of-apps.md index 3d384454..0b7bba83 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/finish-deploy-argocd-app-of-apps.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/finish-deploy-argocd-app-of-apps.md @@ -116,12 +116,12 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | @@ -129,14 +129,14 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------ | -| **`github-token`** | GitHub Token to update the deployment. | **false** | -| | Permissions: | | -| | - deployments: write | | +| **Secret** | **Description** | **Required** | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`github-token`** | GitHub Token to update the deployment. | **false** | +| | Permissions: | | +| | - deployments: write | | | | See [https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status](https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status). | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/prepare-release.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/prepare-release.md index 6dd004d8..d78f41e6 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/prepare-release.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/prepare-release.md @@ -91,13 +91,13 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`working-directory`** | Working directory used to scope release preparation in a monorepo. | **false** | **string** | - | -| | If specified, the workflow looks for `.github/release-configs/{slug}.yml`, where `slug` is derived from the working directory basename. | | | | -| | If that file does not exist, a temporary release configuration is generated with `include-paths` for the working directory and current workflow file. | | | | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`working-directory`** | Working directory used to scope release preparation in a monorepo. | **false** | **string** | - | +| | If specified, the workflow looks for `.github/release-configs/{slug}.yml`, where `slug` is derived from the working directory basename. | | | | +| | If that file does not exist, a temporary release configuration is generated with `include-paths` for the working directory and current workflow file. | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/release-actions.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/release-actions.md index 067a5883..640bc061 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/release-actions.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/github/workflows/release-actions.md @@ -107,16 +107,16 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`update-all`** | Update all actions and workflows, regardless of changes. | **false** | **boolean** | `false` | -| **`documentation-files`** | List of extra documentation files to update (if any). | **false** | **string** | - | -| **`extra-badges`** | JSON array of extra badges to include in generated documentation. | **false** | **string** | - | -| | Each badge should have `label`, `url`, and optional `linkUrl` properties. | | | | -| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`update-all`** | Update all actions and workflows, regardless of changes. | **false** | **boolean** | `false` | +| **`documentation-files`** | List of extra documentation files to update (if any). | **false** | **string** | - | +| **`extra-badges`** | JSON array of extra badges to include in generated documentation. | **false** | **string** | - | +| | Each badge should have `label`, `url`, and optional `linkUrl` properties. | | | | +| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | @@ -124,12 +124,12 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------ | -| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | -| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). | **false** | +| | See [https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md](https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md). | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/index.md index ad60eb6a..d767aba7 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/index.md @@ -198,6 +198,7 @@ gh act -W .github/workflows/workflow-file-to-test.yml ``` 1. **Input Validation**: Always validate inputs early in GitHub Script steps: + ```javascript const urlInput = ${{ toJson(inputs.url ) }}; if (!urlInput) { diff --git a/application/src/pages/index.tsx b/application/src/pages/index.tsx index c1fde235..f27824c8 100644 --- a/application/src/pages/index.tsx +++ b/application/src/pages/index.tsx @@ -101,47 +101,37 @@ function ValuePropsSection() { function ProjectsSection() { const projects = [ { - name: 'compose-action', - icon: '⚡', - url: 'https://github.com/hoverkraft-tech/compose-action', + name: "compose-action", + icon: "⚡", + url: "https://github.com/hoverkraft-tech/compose-action", stars: 210, - language: 'TypeScript', - description: 'This action runs your docker-compose file and clean up before action finished', - tags: [ - 'continuous-integration', - 'docker-compose', - 'github-actions' - ], - accent: 'primary' + language: "TypeScript", + description: + "This action runs your docker-compose file and clean up before action finished", + tags: ["continuous-integration", "docker-compose", "github-actions"], + accent: "primary", }, { - name: 'ci-dokumentor', - icon: '⚡', - url: 'https://github.com/hoverkraft-tech/ci-dokumentor', + name: "ci-dokumentor", + icon: "⚡", + url: "https://github.com/hoverkraft-tech/ci-dokumentor", stars: 5, - language: 'TypeScript', - description: 'Automated documentation generator for CI/CD components', - tags: [ - 'documentation', - 'github-actions', - 'open-source' - ], - accent: 'neutral' + language: "TypeScript", + description: "Automated documentation generator for CI/CD components", + tags: ["documentation", "github-actions", "open-source"], + accent: "neutral", }, { - name: 'ci-github-container', - icon: '⚡', - url: 'https://github.com/hoverkraft-tech/ci-github-container', + name: "ci-github-container", + icon: "⚡", + url: "https://github.com/hoverkraft-tech/ci-github-container", stars: 5, - language: 'Go Template', - description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context', - tags: [ - 'build', - 'containers', - 'continuous-integration' - ], - accent: 'primary' - } + language: "Go Template", + description: + "Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context", + tags: ["build", "containers", "continuous-integration"], + accent: "primary", + }, ]; return (