Skip to content

chore: publish docs from stable release tags only#158

Open
Egge21M wants to merge 2 commits into
masterfrom
feat/docs-publishing
Open

chore: publish docs from stable release tags only#158
Egge21M wants to merge 2 commits into
masterfrom
feat/docs-publishing

Conversation

@Egge21M
Copy link
Copy Markdown
Collaborator

@Egge21M Egge21M commented May 6, 2026

Summary

  • Update the GitHub Pages docs workflow to run only for release.published events.
  • Guard the docs build to tag refs and stable releases by skipping github.event.release.prerelease.
  • Explicitly check out github.event.release.tag_name before building.
  • Remove the master push and manual dispatch triggers so unreleased master docs do not update the live site.

Verification

  • node_modules/.bin/prettier --check .github/workflows/docs.yml
  • git diff --check

Changeset

  • Not added. This is a repository workflow change only.

@github-project-automation github-project-automation Bot moved this to Backlog in coco May 6, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2026

⚠️ No Changeset found

Latest commit: a3bdace

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Egge21M Egge21M marked this pull request as ready for review May 6, 2026 10:36
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0a16f40bd6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/docs.yml Outdated
- '.github/workflows/docs.yml'
workflow_dispatch:
release:
types: [created]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Trigger docs deployment when releases are published

For releases prepared through the GitHub UI as drafts, this created activity will not run; GitHub's release-event docs state that created is skipped for draft releases and that published is the activity that fires when stable or prerelease drafts are published. In that common release flow, publishing the tag/release would leave Pages on the previous docs despite the intent to publish docs from release tags only.

Useful? React with 👍 / 👎.

@Egge21M Egge21M changed the title chore: publish docs from release tags only chore: publish docs from stable release tags only May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant