Skip to content

ci: add primer-api-review workflow - #8302

Open
joshblack wants to merge 5 commits into
docs/add-size-naming-docsfrom
docs/add-workflow-for-api-review
Open

ci: add primer-api-review workflow#8302
joshblack wants to merge 5 commits into
docs/add-size-naming-docsfrom
docs/add-workflow-for-api-review

Conversation

@joshblack

@joshblack joshblack commented Aug 12, 2026

Copy link
Copy Markdown
Member

Closes https://github.com/github/primer/issues/6975

This adds an experimental workflow that will use our new /style-guide skill to conduct an API review and create an issue with any findings. We're curious how this will behave as we flesh out the skill and what it will find in our project over time as we make changes.

Changelog

New

  • Add new CI workflow for weekly API review of components

Changed

Removed

Rollout strategy

  • None; if selected, include a brief description as to why

This is a change to our agentic workflows and is not a part of the public API

@changeset-bot

changeset-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: df8a147

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joshblack joshblack changed the title docs/add workflow for api review ci: add primer-api-review workflow Aug 12, 2026
@github-actions github-actions Bot added the staff Author is a staff member label Aug 12, 2026
@joshblack joshblack added skip changeset This change does not need a changelog integration-tests: skipped manually Changes in this PR do not require an integration test labels Aug 12, 2026
@joshblack
joshblack marked this pull request as ready for review August 12, 2026 21:40
@joshblack
joshblack requested a review from a team as a code owner August 12, 2026 21:40
@joshblack
joshblack requested review from siddharthkp and a lite review from Copilot August 12, 2026 21:40
@github-actions
github-actions Bot requested a deployment to storybook-preview-8302 August 12, 2026 21:46 Abandoned

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a new Agentic Workflows-based CI workflow that periodically audits @primer/react component APIs against the repo’s style guide and keeps a single tracking issue (“Primer API Review”) up to date with unresolved findings.

Changes:

  • Adds a new weekly + manually triggerable “Primer API Review” agentic workflow definition and its compiled lock workflow.
  • Adds an agentic-workflows routing skill to help direct future gh-aw workflow work to the right upstream prompts.
  • Updates the gh-aw actions lock metadata and adjusts .gitattributes handling for generated lock workflows.
Show a summary per file
File Description
.github/workflows/primer-api-review.md Defines the agentic workflow prompt/instructions and context-gathering step for weekly API reviews.
.github/workflows/primer-api-review.lock.yml Adds the compiled GitHub Actions workflow that runs the agent, safe-outputs handling, and threat detection.
.github/skills/agentic-workflows/SKILL.md Introduces a dispatcher skill for designing/debugging/upgrading gh-aw workflows using upstream prompt files.
.github/aw/actions-lock.json Updates pinned gh-aw action metadata used for agentic workflow tooling.
.gitattributes Tweaks attributes applied to generated *.lock.yml workflow files.

Review details

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 4/5 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread .github/workflows/primer-api-review.lock.yml
@joshblack

Copy link
Copy Markdown
Member Author

@copilot update this to only run on workflow dispatch for now

Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@copilot update this to only run on workflow dispatch for now

Updated in 4d9e9fd; the workflow now runs only via workflow_dispatch.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: skipped manually Changes in this PR do not require an integration test skip changeset This change does not need a changelog staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants