Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: CI

# Branches are covered by `pull_request`; `main` by `push`. Restricting push to
# main is what stops a branch with an open PR producing two runs of this
# workflow -- the same approach the installed docs-ci.yml takes, and the reason
# workflow -- the same approach docs.yml takes, and the reason
# it needs no concurrency group either.
#
# An earlier version triggered on every push *and* pull_request, deduplicated by
Expand Down
152 changes: 0 additions & 152 deletions .github/workflows/docs-ci.yml

This file was deleted.

121 changes: 0 additions & 121 deletions .github/workflows/docs-deploy.yml

This file was deleted.

23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Docs

on:
push:
branches: [main]
pull_request:

permissions: {}

jobs:
docs:
permissions: { contents: read, pages: write, id-token: write }
uses: The-Running-Dev/GitHub-ActionTemplates/.github/workflows/docs.yml@v0
with:
output: artifacts/docs
changelog: docs/docs/engine/CHANGELOG.md
changelog-front-matter: 'slug: changelog'
pre-build: ./build/Test-Documentation.ps1
# The landing page is built, browser-tested and merged into the documentation build.
node-project: site
node-scripts: check merge
node-dependencies: src/engine
browser: true
4 changes: 2 additions & 2 deletions .github/workflows/host-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ jobs:
uses: docker/setup-buildx-action@v3

# Needed to pull ghcr.io/the-running-dev/docs-template, the base image the docs
# stage builds from -- docs-ci.yml and docs-deploy.yml authenticate to it the same
# way. Not needed to *push* anything; this job never publishes.
# stage builds from. (docs.yml no longer needs it: the shared docs workflow builds
# on the build-agent image.) Not needed to *push* anything; this job never publishes.
- name: Log in to GHCR (pull docs-template)
uses: docker/login-action@v3
with:
Expand Down
13 changes: 7 additions & 6 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
# 1. the standalone landing page (site/dist);
# 2. the Docusaurus documentation, through the repository's supported template path;
# 3. the protected merge of the two (§4 step 3 -- the package-backed `merge` command
# site/package.json runs, the same command docs-ci.yml's verify job proves on every PR);
# site/package.json runs, the same command docs.yml's Build job proves on every PR);
# 4. the ASP.NET product host, composed with the one pinned, released
# SubZeroDev.Platform.Hosting package (§3 -- no sibling checkout, no floating range);
# 5. a runtime stage carrying only the published host and the verified combined
# artifact -- no Node, no npm cache, no source tree, no build tooling, no
# registry credential (§5, §6).
#
# CHANGELOG.md is not regenerated inside this build (docs-deploy.yml's own job does that
# CHANGELOG.md is not regenerated inside this build (docs.yml's changelog step does that
# from full git history, which this build intentionally does not clone for). The
# committed docs/docs/engine/CHANGELOG.md -- already documented as a static fallback for
# anyone reading the repository directly -- ships instead. That is the one place this
# image's docs subtree can differ from a fresh GitHub Pages deploy; every route the site
# actually serves is otherwise the same combined artifact docs-deploy.yml produces.
# actually serves is otherwise the same combined artifact docs.yml produces.

########################################################################################
# site -- the engine package build the landing page needs, then the landing page itself.
Expand All @@ -43,9 +43,10 @@ COPY docs/docs/engine/TODO.md docs/docs/engine/TODO.md
RUN npm --prefix site run build

########################################################################################
# docs -- the Docusaurus build, through the same supported template path docs-ci.yml and
# docs-deploy.yml both use. The base image already carries /template with node_modules
# and pwsh installed; docs-build.ps1 overlays ./docs over it and runs the real build.
# docs -- the Docusaurus build, through the docs-template image's supported template path
# (docs.yml builds the same overlay on the build-agent image instead). The base image
# already carries /template with node_modules and pwsh installed; docs-build.ps1 overlays
# ./docs over it and runs the real build.
########################################################################################
FROM ghcr.io/the-running-dev/docs-template:latest AS docs
WORKDIR /workspace
Expand Down
6 changes: 3 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ client, MCP server, site, docs, host) identify the same candidate SHA.

## 5. Release-note source

The changelog is generated from `main`'s merge history by `build/ConvertTo-Changelog.ps1` into
`docs/docs/engine/CHANGELOG.md`. There is no hand-maintained changelog and this checklist does
not start one.
The changelog is generated from `main`'s merge history into `docs/docs/engine/CHANGELOG.md` by the
docs workflow's `changelog` input (GitHub-ActionTemplates `actions/changelog`). There is no
hand-maintained changelog and this checklist does not start one.

The immutable release-note source for `0.11.0` is the commit range:

Expand Down
Loading
Loading