Skip to content

RC docs-sync audit log — Yoast SEO #390

@enricobattocchi

Description

@enricobattocchi

RC docs-sync — Yoast SEO

This is the audit log for the RC docs-sync workflow running on Yoast SEO (free, Yoast/wordpress-seo).

The workflow runs daily at 06:00 UTC. For every new RC tag in the source repo, it analyzes the diff against the last processed release, decides whether the developer-portal docs need updating, and — when warranted — opens one draft PR per affected feature area. Every run posts one comment to this issue, regardless of whether any PRs were opened, so this thread is the canonical record of what was checked and when.

How to read the comments

Every comment starts with a machine-readable marker. The workflow uses these markers to determine which RCs have already been processed — please do not edit or delete comments that contain a marker, otherwise the next run may re-process or skip RCs.

<!-- rc-docs-sync:v1 product=wordpress-seo rc_tag=27.5-RC1 -->

After the marker, the comment body falls into one of these shapes:

  • No-op run"no doc changes needed". The RC contained only tests, translations, lockfile bumps, or internal refactors with no public-surface impact. The marker is posted; no PR is opened.
  • PR-producing run — lists the PRs opened, with links and brief rationales. Each PR's title is Yoast SEO <base-version> — docs(<area>): <title>.
  • Coverage gaps observed — if the agent saw new public surface (a new filter, REST route, or top-level src/<subsystem>/) that doesn't match any area in AGENT_MAP.md, it lists them under that heading. Informational only; updating the map is a separate manual PR.

Find the PRs

Filter by labels: rc-doc-sync + product/wordpress-seo.

https://github.com/Yoast/developer/pulls?q=is%3Apr+label%3Arc-doc-sync+label%3Aproduct%2Fwordpress-seo

Backfill a specific past RC

Run the RC docs sync workflow manually via "Run workflow" with product=wordpress-seo and the RC tag you want to backfill.

Pause / disable

Comment out the schedule: trigger in the workflow YAML, or remove the wordpress-seo entry from the PRODUCTS dict at the top of the workflow's resolve-queue step.

Related artifacts

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions