Skip to content

automation: auto-update release calendar docs on new release tags #26171

@ausbru87

Description

@ausbru87

Problem

The release calendar in docs/install/releases/index.md is supposed to be autogenerated by scripts/update-release-calendar.sh, but there is no CI workflow that actually runs it when a new release tag is pushed.

As a result, patch releases (e.g. v2.34.1, v2.33.7, v2.32.6) are not reflected in the docs until someone manually opens a PR. This was surfaced in PLAT-321 / PR #26167.

Root cause

The script works correctly. Its matcher (git tag | grep '^v[0-9]*\.[0-9]*\.[0-9]*$') picks up all semver patch tags. What is missing is a GitHub Actions workflow that runs the script on push to v* tags and opens a PR against main with the updated docs.

  • weekly-docs.yaml only does link checking, not calendar updates.
  • release.yaml does not call update-release-calendar.sh.
  • No other workflow covers this.

Fix

Add .github/workflows/update-release-calendar.yaml that:

  1. Triggers on push to v* tags (skipping release candidates).
  2. Checks out the repo with fetch-depth: 0 and fetch-tags: true so git tag returns the full tag list.
  3. Runs ./scripts/update-release-calendar.sh.
  4. Runs pnpm run format-docs to keep the table aligned.
  5. If docs/install/releases/index.md changed, pushes a branch and opens a PR against main.

Also supports workflow_dispatch for manual reruns.

Generated by Coder Agents

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions