docs(repository-dispatch): use real token name in README example#143
Merged
Conversation
The Usage example referenced `secrets.CROSS_REPO_DISPATCH_TOKEN`, which is not a secret that exists in any caller repo. Anyone copying the example would wire up a non-existent secret and silently get an empty GH_TOKEN — repository_dispatch would then fail authentication on the target repo. The canonical caller in this repo (`.github/workflows/dispatch-integration-tests.yaml`) and loft-enterprise's release.yaml both use `VCLUSTERLABS_DISPATCH_TOKEN`. Align the example with reality so the copy-paste path works.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Usage example in
.github/actions/repository-dispatch/README.mdreferencedsecrets.CROSS_REPO_DISPATCH_TOKEN, which isn't a secret that exists in any caller repo. Anyone copying the example would wire up a non-existent secret and silently end up with an emptyGH_TOKEN, causingrepository_dispatchto fail authentication on the target repo.The canonical caller in this repo (
.github/workflows/dispatch-integration-tests.yaml:31) andloft-sh/loft-enterprise'srelease.yamlboth useVCLUSTERLABS_DISPATCH_TOKEN. This PR aligns the README example with the real secret name so copy-paste works.The typo was introduced in #140 (the original PR that added this composite action).
Scope
AUTO-DOC-INPUT:START/END) untouched — out of scopeFollow-up after merge
The
repository-dispatch/v1floating tag needs to be force-moved to the merge commit so existing consumers pinned at@repository-dispatch/v1pick up the fix (same retag pattern used for DEVOPS-855 / v1.3.1). Flagging here so a human with retag permissions can do it.Test plan
grep -n CROSS_REPO_DISPATCH_TOKEN .github/actions/repository-dispatch/README.mdreturns nothing.github/workflows/dispatch-integration-tests.yaml(this repo) andloft-sh/loft-enterpriserelease.yaml— both useVCLUSTERLABS_DISPATCH_TOKEN