docs: align release checklist with optional search sync + generated manifests #62

New issue

Closed

opened 2026-03-22 15:16:19 +00:00 by pokebedrock-bot · 0 comments

pokebedrock-bot commented

2026-03-22 15:16:19 +00:00

(Migrated from github.com)

Summary

The release-checklist docs still describe wiki-search as if backend sync secrets are always required and only instruct readers to verify build/search-index.json plus build/search-indices.json, even though the workflow also emits the generated frontend content manifests and the backend sync is intended to be optional when repo secrets are unset.

Evidence

docs/en/reference/release-checklist.md
- Pre-Deploy says to "verify search-index CI secrets are present for the target repo"
- Publish / Sync step 4 only mentions build/search-index.json and build/search-indices.json
docs/es/reference/release-checklist.md
- Has the same guidance in Spanish
Current workflow and repo behavior:
- .github/workflows/search-index.yml uploads the generated content manifests alongside the two search JSON files
- Open issue #38 documents that backend sync should be treated as optional when WIKI_SEARCH_SYNC_URL / WIKI_SEARCH_SYNC_TOKEN are unset

Impact

Release operators can think a repo is misconfigured when optional backend-sync secrets are intentionally absent.
The checklist under-documents the artifacts that should exist after a successful search build, so generated-manifest regressions are easier to miss.
English and Spanish release docs drift from the actual workflow behavior in the same way.

Acceptance criteria

English and Spanish release-checklist docs explain that backend sync secrets are only required when the website-backend sync integration is enabled.
Publish verification calls out the generated frontend content manifests in addition to build/search-index.json and build/search-indices.json.
Backend sync verification is phrased conditionally so the checklist still makes sense when sync is intentionally skipped.

## Summary The release-checklist docs still describe `wiki-search` as if backend sync secrets are always required and only instruct readers to verify `build/search-index.json` plus `build/search-indices.json`, even though the workflow also emits the generated frontend content manifests and the backend sync is intended to be optional when repo secrets are unset. ## Evidence - `docs/en/reference/release-checklist.md` - Pre-Deploy says to "verify search-index CI secrets are present for the target repo" - Publish / Sync step 4 only mentions `build/search-index.json` and `build/search-indices.json` - `docs/es/reference/release-checklist.md` - Has the same guidance in Spanish - Current workflow and repo behavior: - `.github/workflows/search-index.yml` uploads the generated content manifests alongside the two search JSON files - Open issue #38 documents that backend sync should be treated as optional when `WIKI_SEARCH_SYNC_URL` / `WIKI_SEARCH_SYNC_TOKEN` are unset ## Impact - Release operators can think a repo is misconfigured when optional backend-sync secrets are intentionally absent. - The checklist under-documents the artifacts that should exist after a successful search build, so generated-manifest regressions are easier to miss. - English and Spanish release docs drift from the actual workflow behavior in the same way. ## Acceptance criteria - English and Spanish release-checklist docs explain that backend sync secrets are only required when the website-backend sync integration is enabled. - Publish verification calls out the generated frontend content manifests in addition to `build/search-index.json` and `build/search-indices.json`. - Backend sync verification is phrased conditionally so the checklist still makes sense when sync is intentionally skipped.