Skip to content

[Workflows] Scope README regen to changed paths with concurrency guard #67

@ashleyshaw

Description

@ashleyshaw

name: "🤖 Automation"
about: "Propose, fix, or improve automation (actions, scripts, bots)."
title: "[Workflows] Scope README regen to changed paths with concurrency guard"
labels: [area:workflows, v0.2.0, branding, status:needs-triage, area:automation]

Automation Summary

Update the readme-regen.yml workflow to:

  • Use paths: filters to target only directories/files that have changed.
  • Implement concurrency: group to ensure only one regeneration runs per target at once.
  • Write only the README files affected by a given change, not all READMEs.

Steps / Checklist

  • Task is clearly defined and actionable
  • Automation goal and scope described
  • Documentation/changelog updated
  • PR uses correct branch prefix (automation/)
  • Approved by at least one maintainer

Acceptance Criteria

  • readme-regen.yml uses paths: filters and concurrency: group.
  • Writes only affected README files.
  • Automation implemented and tested
  • Documentation updated
  • No regressions or negative impact

Additional Context

Owner: Workflows


Definition of Ready (DoR)

  • Automation goal/scope defined
  • Checklist prepared
  • Estimate added

Definition of Done (DoD)

  • All checklist and acceptance criteria completed
  • Documentation/changelog updated
  • Approved by maintainer

Metadata

Metadata

Assignees

Priority

None yet

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions