[docs-agent] Add workflow_dispatch to changelog and SDK-refs indexers - #1483
Merged
Conversation
Both workflows previously had no manual trigger path: * index-changelog.yml only fires on push to content/changelog/**, so it cannot be re-run without a real content commit. * index-sdk-references.yml only fires on repository_dispatch from the aa-sdk repo. This came out of the 2026-07-27 search outage (DOCS-163), where the production Algolia index was wiped externally and neither of these indexers could be re-triggered from the GitHub UI. Adding workflow_dispatch keeps the existing security guard for repository_dispatch on index-sdk-references (still restricted to alchemyplatform/aa-sdk source) while letting maintainers with Actions: write dispatch either indexer manually. Matches the shape already used by index-main-content.yml. Refs DOCS-164 Requested-by: @dslovinsky
🔗 Preview Mode
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: db652ee850
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
The indexer scripts hard-code --branch=main and write to the main_alchemy_docs Algolia index. Without a ref guard, a workflow_dispatch run from a feature branch or tag would push that branch's content into the production index. Add if: github.ref == 'refs/heads/main' to both jobs; keep the existing repository_dispatch source restriction on index-sdk-references. Addresses codex review comment on PR #1483: #1483 (comment) Refs DOCS-164 Requested-by: @dslovinsky
vahnag
approved these changes
Jul 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to the 2026-07-27 search outage (DOCS-163). Two of the three Algolia indexer workflows could not be triggered manually:
index-changelog.yml— fired only onpushtocontent/changelog/**, so re-running it required a real content commit.index-sdk-references.yml— fired only onrepository_dispatchfromalchemyplatform/aa-sdk, so it had no path from the GitHub Actions UI.This adds
workflow_dispatch: {}to both, matching the shape already used byindex-main-content.yml.For
index-sdk-references.yml, the job's existingif:guard would skip aworkflow_dispatchrun becausegithub.event.client_payload.sourceis null on a manual dispatch. The guard is relaxed togithub.event_name == 'workflow_dispatch' || github.event.client_payload.source == 'alchemyplatform/aa-sdk'so:workflow_dispatch(which already requiresActions: writeon the repo, so caller identity is trusted) runs the job unconditionally.repository_dispatchstill requires thesource == 'alchemyplatform/aa-sdk'payload, so cross-repo dispatch is not opened up.Linear
DOCS-164 — https://linear.app/alchemyapi/issue/DOCS-164/add-workflow-dispatch-to-changelog-and-sdk-refs-indexer-workflows
Requested by
@dslovinsky (via Slack thread)