diff --git a/.github/actions/prerelease-setup/README.md b/.github/actions/prerelease-setup/README.md index fb47160..8b17c43 100644 --- a/.github/actions/prerelease-setup/README.md +++ b/.github/actions/prerelease-setup/README.md @@ -39,14 +39,14 @@ provisioning (`aws-test-infra`) and the Ginkgo test execution -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------------------|--------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| github-token | string | true | | GitHub token with contents:read on loft-sh/loft-enterprise.
Required because the platform release resolvers
call the GitHub API for a
private repo; unauthenticated calls return 404.
Pass ${{ github.token }} from a
job whose permissions grant contents:read. | -| platform-base-version | string | false | | Platform version for the initial install
(e.g. 4.9.0). Empty resolves to the latest
stable release of loft-sh/loft-enterprise. | -| platform-rc-version | string | false | | Platform RC version for upgrade (e.g. 4.10.0-alpha.6).
Empty resolves to the latest pre-release
of loft-sh/loft-enterprise. | -| role-session-name | string | true | | AWS STS role-session-name. Each consumer job
passes a distinct value (e.g. prerelease-vcluster-, prerelease-aicloud-). | -| standalone-vcluster-upgrade-version | string | false | | vCluster version to upgrade standalone to
(e.g. 0.35.0-alpha.7). Empty resolves to the latest
vCluster pre-release. Must differ from the
resolved base version. | -| standalone-vcluster-version | string | false | | vCluster version to install for standalone
(e.g. 0.34.0). Empty resolves to the latest
GitHub release of loft-sh/vcluster. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|-------------------------------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| github-token | string | true | | GitHub token with contents:read on loft-sh/loft-enterprise.
Required because the platform release resolvers
call the GitHub API for a
private repo; unauthenticated calls return 404.
Pass the calling job's github.token from
a job whose permissions grant contents:read. | +| platform-base-version | string | false | | Platform version for the initial install
(e.g. 4.9.0). Empty resolves to the latest
stable release of loft-sh/loft-enterprise. | +| platform-rc-version | string | false | | Platform RC version for upgrade (e.g. 4.10.0-alpha.6).
Empty resolves to the latest pre-release
of loft-sh/loft-enterprise. | +| role-session-name | string | true | | AWS STS role-session-name. Each consumer job
passes a distinct value (e.g. prerelease-vcluster-, prerelease-aicloud-). | +| standalone-vcluster-upgrade-version | string | false | | vCluster version to upgrade standalone to
(e.g. 0.35.0-alpha.7). Empty resolves to the latest
vCluster pre-release. Must differ from the
resolved base version. | +| standalone-vcluster-version | string | false | | vCluster version to install for standalone
(e.g. 0.34.0). Empty resolves to the latest
GitHub release of loft-sh/vcluster. | diff --git a/.github/actions/prerelease-setup/action.yml b/.github/actions/prerelease-setup/action.yml index 1044973..9b960c8 100644 --- a/.github/actions/prerelease-setup/action.yml +++ b/.github/actions/prerelease-setup/action.yml @@ -6,7 +6,7 @@ inputs: description: 'AWS STS role-session-name. Each consumer job passes a distinct value (e.g. prerelease-vcluster-, prerelease-aicloud-).' required: true github-token: - description: 'GitHub token with contents:read on loft-sh/loft-enterprise. Required because the platform release resolvers call the GitHub API for a private repo; unauthenticated calls return 404. Pass ${{ github.token }} from a job whose permissions grant contents:read.' + description: 'GitHub token with contents:read on loft-sh/loft-enterprise. Required because the platform release resolvers call the GitHub API for a private repo; unauthenticated calls return 404. Pass the calling job''s github.token from a job whose permissions grant contents:read.' required: true standalone-vcluster-version: description: 'vCluster version to install for standalone (e.g. 0.34.0). Empty resolves to the latest GitHub release of loft-sh/vcluster.'