Skip to content

Move AUTOMATIONS.md into readme/ #5069

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

Open
jsundai wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −3
Open

Move AUTOMATIONS.md into readme/ #5069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4909473
move
jsundai Aug 7, 2026
add0e27
Merge branch 'main' into move-automations-to-readme
jsundai Aug 7, 2026
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 AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repository.
| Mermaid diagrams | [MERMAID.md](./readme/MERMAID.md) |
| LLM Markdown pipeline | [MARKDOWN_PIPELINE.md](./readme/MARKDOWN_PIPELINE.md) |
| Component → Markdown mapping | [COMPONENT_REGISTRY.md](./readme/COMPONENT_REGISTRY.md) |
| CI jobs and scheduled jobs | [AUTOMATIONS.md](./AUTOMATIONS.md) |
| CI jobs and scheduled jobs | [AUTOMATIONS.md](./readme/AUTOMATIONS.md) |

## Repository overview

Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This repository contains a large chunk of the Temporal information corpus.
| [Readability tooling guidance](./readme/READABILITY.md) | For repo maintainers |
| [Style guidance](./readme/STYLE.md) | For our open source community |
| [Utility tooling guidance](./readme/UTILITIES.md) | For repo maintainers |
| [Automations inventory](./readme/AUTOMATIONS.md) | For repo maintainers |

### Current component versioning philosophy

Expand Down
4 changes: 2 additions & 2 deletions AUTOMATIONS.md → readme/AUTOMATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Every automation in this repository, grouped by what triggers it. Use this to fi
something new, and to know what to update when you change or rename a job.

When you add or rename an automation, update this file and the `workflows:` list in
[`notify-automation-failures.yml`](./.github/workflows/notify-automation-failures.yml). That list matches on a
[`notify-automation-failures.yml`](../.github/workflows/notify-automation-failures.yml). That list matches on a
workflow's `name:` value, so a rename silently unhooks its failure alert.

## Content generation
Expand Down Expand Up @@ -32,7 +32,7 @@ a 404 rather than a 403, so a scope mistake looks like a missing file.
| Check Metrics Reference | Changes to `docs/references/sdk-metrics.mdx` | Yes | `check-metrics-reference.yml`, `bin/check-metrics-reference.js` | Checks the page against itself. The comparison with the SDK sources is a separate, advisory job. |
| Environment config drift | Changes to the client environment configuration page | Yes | `env-config-drift.yml`, `bin/check-env-config-table.js` | Also runs weekly, because it fetches sources over the network and an outage should not block unrelated pull requests. |
| Mermaid CI | Changes under `docs/` | Yes | `mermaid-ci.yml`, `scripts/lint-mermaid.mjs` | Validates diagram syntax across the docs tree. |
| Vale CI | Changes under `docs/` | No | `vale-ci.yml`, `.vale-ci.ini` | Runs only the rules in `.vale-ci.ini`, with `fail_on_error: false` and results limited to changed context. Treat those rules as the bar, not the full style set. See [AGENTS.md](./AGENTS.md#commands). |
| Vale CI | Changes under `docs/` | No | `vale-ci.yml`, `.vale-ci.ini` | Runs only the rules in `.vale-ci.ini`, with `fail_on_error: false` and results limited to changed context. Treat those rules as the bar, not the full style set. See [AGENTS.md](../AGENTS.md#commands). |
| Check Orphan Pages | Changes to docs or `sidebars.js` | No | `check-orphan-pages.yml`, `bin/check-orphan-pages.js` | Never fails; comments and annotates only. Accepted exceptions belong in `bin/orphan-pages-baseline.json` with a note. See [UTILITIES.md](./UTILITIES.md#check-orphan-pages). |
| Check Metrics Against SDKs | Changes to the metrics page or its checker | No | `check-metrics-against-sdks.yml` | Drift reports but does not fail. On its scheduled runs it manages a tracking issue instead. |
| Docs Preview Links | Every pull request | No | `docs-preview-links.yml`, `bin/generate-docs-preview-list.js` | Reads the preview URL out of Vercel's own comment, then upserts a single comment listing the pages the pull request changes. |
Expand Down