Skip to content

Document the GitHub tags trigger and updating docs after each deploy - #1016

Open
promptless[bot] wants to merge 13 commits into
mainfrom
promptless/deployment-trigger-5098
Open

promptless[bot] wants to merge 13 commits into
mainfrom
promptless/deployment-trigger-5098

Conversation

@promptless

@promptless promptless Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

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 deployment trigger 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:

  • A new guide, Update docs after each deploy. It covers creating an API key and storing it as the PROMPTLESS_API_KEY GitHub Actions secret. It includes a complete GitHub Actions workflow that sends POST /v1/triggers after the deploy step. It explains the instructions and context fields, the Idempotency-Key header, the 202 response, deploying from a tag, and sending only production deploys. The guide is added to the "Get the most out of it" sidebar group in astro.config.mjs.
  • The trigger reference page is renamed from GitHub deployments to GitHub tags (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.
  • The Triggers landing card, the Configuration Reference deployment entry, and the September 2026 changelog entry now use the GitHub tags name and link.
  • The API triggers page's CI/CD use case links to the new guide.
  • Both new pages follow the frontmatter and page-type conventions from docs: Lint page structure with manni, restructure every docs page by type, and embed integration procedures as partials #1177. Each has an id, a type: how-to, last-updated, and an entry in docs.metadata.yaml with created and owner stamped by manni meta derive. Each also has an Overview section and a See also section. The old timestamp field is gone.

Following PROMPTLESS.md, the guide's request body contains only instructions and context.

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:

  • The trigger hasn't yet run against a real GitHub tag push, according to #5098's Verification section. The main open question is whether GitHub's push event includes base_ref when expected, because that field drives the branches filter.
  • The trigger page's "What to expect" section lists display limitations that remain deferred in the source: the Triggers page shows the literal deployment with 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.
  • The source doesn't say what happens on the first tag push that has no earlier matching tag, so the page doesn't cover that case.
  • The deploy guide's workflow wasn't run against the live API. The request shape, 202 response, and idempotency behavior come from the API triggers reference.

Checklist

  • Instructions and examples match the current product behavior.
  • Links and image references are valid.
  • Changed pages render correctly.

Validation: npm run build passes, and both new routes render with the new sidebar entry. npx manni meta validate passes on all 133 pages, and npx manni lint structure passes on both new pages. remark --frail passes. Vale reports no new findings in the changed files.

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
@vercel

vercel Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
promptless-docs Ready Ready Preview Oct 20, 2026 5:52pm UTC

Request Review

Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/configuration-reference.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/deployment.mdx Outdated
@promptless
promptless Bot marked this pull request as ready for review September 23, 2026 22:16
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/github-tags.mdx

This branch was successfully deployed

1 active deployment
Preview — bdeb30fd Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants