Skip to content

chore(docs): regenerate the agent skill references after merge instead of in every PR - #8807

Merged
leandrodamascena merged 1 commit into
developfrom
chore/agent-skill-references-post-merge
Nov 14, 2026
Merged

leandrodamascena merged 1 commit into
developfrom
chore/agent-skill-references-post-merge

Conversation

@leandrodamascena

Copy link
Copy Markdown
Contributor

Issue number:
closes #8806

Summary

Changes

The agent skill references stop being the contributor's problem:

  • tests/functional/test_agent_skill_references.py is gone. A docs PR changes docs and nothing else; nobody has to know the generated folder exists.
  • New workflow agent_skill_references.yml: on every push to develop that touches docs/, examples/ or the generator, it regenerates the references and opens a PR through our create-pr action when anything changed. Same mechanism as the changelog rebuild; duplicates with the same title are closed by the action, so a burst of docs merges ends in one PR.
  • The generator drops the per-region layer ARN tables and masks the version suffix as :<version> in the examples, pointing to the installation page instead. That is what caused the drift after 3.40.0 (chore(ci): layer docs update bumps :42 to :43 in 300 lines through a bot PR that never runs pre-commit), and an agent has no use for thirty ARNs that change weekly. installation.md loses 300 lines of churn.
  • Pre-commit hook and make agent-skill stay for those who have them; AGENTS.md says they are optional now.

User experience

Contributors: no more "Agent skill references are out of date" failures on PRs that only touch docs. Four of the ten PRs in 3.41.0 were failing on it.

Skill users: the installation reference points to the docs for ARNs instead of carrying a table that is one release behind.

Verification

Generator run and --check clean, ruff clean on the script, workflow YAML parsed, references regenerated with this generator. The workflow reuses the pinned checkout and the create-pr action from reusable_publish_changelog.yml, so the permissions and the no-changes early exit are the ones already in use. Written with an AI assistant; I ran everything above myself.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@leandrodamascena
leandrodamascena requested a review from a team as a code owner November 14, 2026 12:11
@leandrodamascena leandrodamascena added this to the 3.41.0 milestone Nov 14, 2026
@leandrodamascena leandrodamascena added documentation Improvements or additions to documentation tech-debt Technical Debt tasks labels Nov 14, 2026
@boring-cyborg boring-cyborg Bot added github-actions Pull requests that update Github_actions code tests labels Nov 14, 2026
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 14, 2026
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.18%. Comparing base (b0d3a3c) to head (99775a1).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8807   +/-   ##
========================================
  Coverage    97.18%   97.18%           
========================================
  Files          323      323           
  Lines        16555    16555           
  Branches      1496     1496           
========================================
  Hits         16089    16089           
  Misses         326      326           
  Partials       140      140           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@leandrodamascena
leandrodamascena merged commit b0e6305 into develop Nov 14, 2026
22 checks passed
@leandrodamascena
leandrodamascena deleted the chore/agent-skill-references-post-merge branch November 14, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation github-actions Pull requests that update Github_actions code size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tech-debt Technical Debt tasks tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Maintenance: stop asking contributors to regenerate the agent skill references

1 participant