From 9ee8eb15619fda1f11dfcb0f13f86b3aa47c1c04 Mon Sep 17 00:00:00 2001 From: Tai Sakuma Date: Sun, 22 Mar 2026 06:36:44 -0400 Subject: [PATCH] refactor: rename docs workflows to start with a verb MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Documentation → Deploy dev docs - Documentation (Release) → Deploy release docs - Documentation (PR Preview) → Deploy docs preview - Documentation (PR Cleanup) → Remove docs preview - Rename docs.yml → docs-dev.yml Co-Authored-By: Claude Opus 4.6 (1M context) --- .github/workflows/{docs.yml => docs-dev.yml} | 2 +- .github/workflows/docs-pr-cleanup.yml | 2 +- .github/workflows/docs-pr-preview.yml | 2 +- .github/workflows/docs-release.yml | 2 +- README.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) rename .github/workflows/{docs.yml => docs-dev.yml} (96%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs-dev.yml similarity index 96% rename from .github/workflows/docs.yml rename to .github/workflows/docs-dev.yml index d0688ab..5e187fe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs-dev.yml @@ -1,4 +1,4 @@ -name: Documentation +name: Deploy dev docs on: push: diff --git a/.github/workflows/docs-pr-cleanup.yml b/.github/workflows/docs-pr-cleanup.yml index 1dc43c7..100ed54 100644 --- a/.github/workflows/docs-pr-cleanup.yml +++ b/.github/workflows/docs-pr-cleanup.yml @@ -1,4 +1,4 @@ -name: Documentation (PR Cleanup) +name: Remove docs preview on: pull_request: diff --git a/.github/workflows/docs-pr-preview.yml b/.github/workflows/docs-pr-preview.yml index b0357eb..090ec66 100644 --- a/.github/workflows/docs-pr-preview.yml +++ b/.github/workflows/docs-pr-preview.yml @@ -1,4 +1,4 @@ -name: Documentation (PR Preview) +name: Deploy docs preview # Use pull_request_target so the workflow has write permissions even for fork # PRs. The pull_request trigger restricts fork PRs to a read-only GITHUB_TOKEN, diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml index f5f9688..ec9f3d5 100644 --- a/.github/workflows/docs-release.yml +++ b/.github/workflows/docs-release.yml @@ -1,4 +1,4 @@ -name: Documentation (Release) +name: Deploy release docs on: workflow_run: diff --git a/README.md b/README.md index 130a8bd..784ad8f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Documentation is built with [zensical](https://zensical.org/) and deployed by pu | Workflow | Trigger | Deploys to | | --------------------- | -------------------------------- | ----------------------------------------- | -| `docs.yml` | Push to `main` | `/dev/` | +| `docs-dev.yml` | Push to `main` | `/dev/` | | `docs-release.yml` | Release (via changelog workflow) | `//` + `/latest/` + `index.html` | | `docs-pr-preview.yml` | PR opened/updated (incl. forks) | `/pr//` | | `docs-pr-cleanup.yml` | PR closed | removes `/pr//` |