Skip to content

Commit 570753d

Browse files
committed
Disable automatic preview deploys
1 parent 6ae0004 commit 570753d

3 files changed

Lines changed: 12 additions & 14 deletions

File tree

.github/workflows/preview-pages.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Deploy Preview Pages
22

33
on:
4-
push:
5-
branches:
6-
- docs-autoresearch-preview
74
workflow_dispatch:
85

96
permissions:

AGENTS.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,18 @@ pick up immediately.
2121
- `main` is the production branch.
2222
- Pushing `main` triggers [`.github/workflows/deploy-pages.yml`](./.github/workflows/deploy-pages.yml)
2323
and deploys the production GitHub Pages site.
24-
- `docs-autoresearch-preview` is a preview branch.
25-
- Pushing `docs-autoresearch-preview` triggers
26-
[`.github/workflows/preview-pages.yml`](./.github/workflows/preview-pages.yml),
27-
which publishes a preview build under the Pages preview subpath while keeping
28-
the root site aligned with `main`.
24+
- `docs-autoresearch-preview` remains the preview branch name, but its Pages
25+
workflow is currently manual-only.
26+
- [`.github/workflows/preview-pages.yml`](./.github/workflows/preview-pages.yml)
27+
can still publish a preview build under the Pages preview subpath while
28+
keeping the root site aligned with `main`, but someone must trigger it
29+
explicitly from the Actions UI.
2930

3031
## Practical rule
3132

32-
- The normal order is: edit locally -> test locally -> push preview branch if
33-
needed -> review -> merge or port to `main` -> let GitHub Pages deploy
34-
production.
33+
- The normal order is: edit locally -> test locally -> if a preview is needed,
34+
trigger the preview workflow manually -> review -> merge or port to `main` ->
35+
let GitHub Pages deploy production.
3536
- Uncommitted local changes are not deployed.
3637
- A commit sitting only on `docs-autoresearch-preview` is not the same thing as
3738
production deployment.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This repo is configured for GitHub Pages deployment:
8181

8282
1. Make and test changes locally first
8383
2. Run `npm run build` before claiming the site is ready
84-
3. Push `docs-autoresearch-preview` if you want a preview deployment
84+
3. Trigger the preview workflow manually if you want a preview deployment
8585
4. Push or merge to `main` when you want the production site updated
8686
5. In GitHub repo settings, set `Pages` source to `GitHub Actions`
8787

@@ -93,8 +93,8 @@ Notes:
9393
before treating the change as ready.
9494
- Production deploys are triggered by `.github/workflows/deploy-pages.yml` on
9595
pushes to `main`.
96-
- Preview deploys are triggered by `.github/workflows/preview-pages.yml` on
97-
pushes to `docs-autoresearch-preview`.
96+
- Preview deploys are currently manual-only through
97+
`.github/workflows/preview-pages.yml`.
9898
- The intended workflow is local preview first, GitHub preview second,
9999
production deploy last.
100100

0 commit comments

Comments
 (0)