Skip to content

ci(dox): deploy after the Release workflow, not beside it - #280

Merged
craig-o-curtis merged 2 commits into
mainfrom
chore/dox-deploy-after-release
Sep 24, 2026
Merged

craig-o-curtis merged 2 commits into
mainfrom
chore/dox-deploy-after-release

Conversation

@craig-o-curtis

Copy link
Copy Markdown
Contributor

Split out of #279 at @baldurpan's suggestion, so the pipeline change can be reviewed on its own.

What changes

deploy-dox.yml now triggers on workflow_run of Release (completed, main) instead of on push.

  • Release runs on every push to main, so every merge still deploys the docs. The deploy now starts after Release finishes, not alongside it.
  • Why: on a push that publishes, Release pushes the @northguild/gmt@X.Y.Z tag. Running in parallel, the docs could build before that tag existed. feat(transport) TRAN-8 transitTime etaAtZone dwellTime #189 #192 #279 adds reference badges that read the newest tag, and this ordering is what keeps a just-released function from being badged Unreleased.
  • Checkout uses the commit Release ran on (workflow_run.head_sha), with full history and tags.
  • Unchanged: the daily schedule and workflow_dispatch.
  • context/dox/built.md: the deploy rule is rewritten. It also said there was no manual trigger, which was already untrue.

Failure mode

If Release ever stops running on pushes to main (renamed, disabled, or given a path filter), merges stop deploying the docs. The daily schedule and the manual trigger still deploy. The workflow header says this.

Merge order

Merge this before the next release PR. Otherwise that release's own functions keep the Unreleased badge until the next deploy, and the daily schedule catches it within a day.

Verification

  • name: Release in release.yml matches workflows: [Release].
  • release.yml triggers on every push to main with no path filter.
  • A workflow_run trigger only takes effect from the default branch, so the first run of the new trigger comes after this merges.

Dox deployed on every push to main, in parallel with the Release
workflow. On a push that publishes, the docs could build before the
`@northguild/gmt@X.Y.Z` tag existed.

- Trigger on `workflow_run` of Release (completed, on main). Release
  runs on every push to main, so every merge still deploys, now after
  its tag is pushed.
- Check out the commit Release ran on, with full history and tags.
- The daily schedule and `workflow_dispatch` are unchanged.

Failure mode: if Release stops running on pushes to main, merges stop
deploying the docs; the schedule and manual trigger still work. The
workflow header and context/dox/built.md say so.

@baldurpan baldurpan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🌭

craig-o-curtis added a commit that referenced this pull request Sep 24, 2026
- `transitTime` keeps a comma-fraction offset (`+05:30:00,5`) as
  written; the capture is built from the canonical `EXTENDED_UTC_OFFSET`.
- New `internal/wallClockAtOffset`, shared by `transitTime` and
  `fromOffsetInstant`, holds the range-limit wall-clock shift once.
- One `TIME_ZONE_ANNOTATION` rule (RFC 9557) feeds `transitTime`,
  `zonedWallClockDifference` and `toOffsetInstant`; the Dox widget's
  stale copy is removed.
- `deps.mjs`: `orderOf` fills the build order on first use.
- Namespace lists gain `interval/` and `transport/`.
- The deploy workflow change moves to #280; this branch restores
  `deploy-dox.yml` to main and points its comments there.
@craig-o-curtis
craig-o-curtis enabled auto-merge (squash) September 24, 2026 09:15
@craig-o-curtis
craig-o-curtis merged commit 89a4a84 into main Sep 24, 2026
38 checks passed
@craig-o-curtis
craig-o-curtis deleted the chore/dox-deploy-after-release branch September 24, 2026 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants