Skip to content

refactor: rename docs workflows to start with a verb #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TaiSakuma merged 1 commit into from
Mar 22, 2026
Merged

refactor: rename docs workflows to start with a verb #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/docs.yml → .github/workflows/docs-dev.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Documentation
name: Deploy dev docs

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-pr-cleanup.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Documentation (PR Cleanup)
name: Remove docs preview

on:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-pr-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Documentation (Release)
name: Deploy release docs

on:
workflow_run:
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) | `/<version>/` + `/latest/` + `index.html` |
| `docs-pr-preview.yml` | PR opened/updated (incl. forks) | `/pr/<number>/` |
| `docs-pr-cleanup.yml` | PR closed | removes `/pr/<number>/` |
Expand Down
Loading