Repository navigation
Document the GitHub tags trigger and updating docs after each deploy - #1016
Open
promptless[bot] wants to merge 13 commits into
Open
promptless[bot] wants to merge 13 commits into
promptless[bot] wants to merge 13 commits into
Conversation
Adds a reference page, landing-page card, configuration-reference entry, and changelog note for the new `deployment` gating trigger, which fires once per release-tag push instead of once per merged PR. Source: Promptless/promptless#5074, #5098
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
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.
Requested by: Frances Liu
Proposed changes
Documents two ways to run Promptless around releases: the GitHub tags trigger (
trigger_type: deployment), and a new guide for calling the Promptless API from CI after a deploy finishes.The dashboard now calls the
deploymenttrigger GitHub tags (source Promptless/promptless#5424). The trigger responds to pushed tags that match a pattern. It doesn't watch GitHub Deployments, so teams that want docs to follow a deploy to staging or production call the API from their pipeline instead. A Miter user asked about this setup in Slack.Adds and changes:
PROMPTLESS_API_KEYGitHub Actions secret. It includes a complete GitHub Actions workflow that sendsPOST /v1/triggersafter the deploy step. It explains theinstructionsandcontextfields, theIdempotency-Keyheader, the202response, deploying from a tag, and sending only production deploys. The guide is added to the "Get the most out of it" sidebar group inastro.config.mjs.connect/triggers/github-tags.mdx), matching the dashboard's catalog entry. The page isn't published yet, so it needs no redirect. It now links to the deploy guide and says the trigger responds to tag pushes, not GitHub Deployments.deploymententry, and the September 2026 changelog entry now use the GitHub tags name and link.id, atype: how-to,last-updated, and an entry indocs.metadata.yamlwithcreatedandownerstamped bymanni meta derive. Each also has an Overview section and a See also section. The oldtimestampfield is gone.Following PROMPTLESS.md, the guide's request body contains only
instructionsandcontext.Sources:
Promptless/promptless#5098 (GitHub tags trigger, building on #5074) and #5424 (rename and docs request from @InlinePizza). All three have merged.Open items to confirm:
base_refwhen expected, because that field drives thebranchesfilter.deploymentwith no logo, and change-history source filters leave these suggestions out. #5424 changed only the configuration picker, the trigger label, and the collapsed summary. Revisit this section when the follow-up work lands.202response, and idempotency behavior come from the API triggers reference.Checklist
Validation:
npm run buildpasses, and both new routes render with the new sidebar entry.npx manni meta validatepasses on all 133 pages, andnpx manni lint structurepasses on both new pages.remark --frailpasses. Vale reports no new findings in the changed files.