Skip to content

feat: add copy proofread review workflow - #309

Merged
stepskop merged 6 commits into
mainfrom
feat/copy-proofread-review
Aug 10, 2026
Merged

feat: add copy proofread review workflow#309
stepskop merged 6 commits into
mainfrom
feat/copy-proofread-review

Conversation

@stepskop

@stepskop stepskop commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Add copy proofread review from workflow. Original idea was to automate the public-facing copy review, that is done manually by a copywriter on a CODEOWNER review request.

On a label-triggered PR, it proofreads the public-facing copy in the given paths against Apify's style guide and leaves inline suggestions. It never approves or requests changes. The rules come from the apify-proofreader skill, sparse-checked-out at run time from apify/agent-skills-internal, so no repo vendors a copy that drifts.

Caller side:

on:
  pull_request:
    types: [labeled]

jobs:
  proofread:
    if: github.event.label.name == 'copy-review'
    uses: apify/workflows/.github/workflows/copy_proofread_review.yaml@main
    secrets:
      anthropicApiKey: ${{ secrets.ANTHROPIC_API_KEY }}
      agentSkillsToken: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
    with:
      paths: |
        - `src/packages/intl/src/en/`

The workflow removes whichever label triggered the caller, so re-adding it re-runs the review.

Test run: https://github.com/apify/apify-core/pull/29111

@github-actions github-actions Bot added the t-core-services Issues with this label are in the ownership of the core services team. label Aug 4, 2026
@stepskop
stepskop force-pushed the feat/copy-proofread-review branch 3 times, most recently from 9657c17 to 2d451b5 Compare August 4, 2026 12:51
Reviews the public-facing copy changed in a PR against the style rules in
an agent skill, checked out at runtime from apify/agent-skills-internal so
callers do not vendor a copy that drifts. Callers pass the paths to review
and, optionally, repo-specific rules for telling copy apart from code.
@stepskop
stepskop force-pushed the feat/copy-proofread-review branch from 2d451b5 to 081fdc6 Compare August 4, 2026 12:53
@stepskop
stepskop requested a lite review from Copilot August 5, 2026 09:29
@stepskop stepskop added the adhoc Ad-hoc unplanned task added during the sprint. label Aug 5, 2026

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

Adds a reusable GitHub Actions workflow that runs a Claude-based “copy proofread” review on demand (typically via a PR label), using style rules loaded at runtime from apify/agent-skills-internal.

Changes:

  • Documented how to call the reusable workflow (including required secrets and optional repo-specific instructions).
  • Added .github/workflows/copy_proofread_review.yaml reusable workflow that installs the apify-proofreader skill and runs anthropics/claude-code-action to leave inline suggestions.
  • Added automatic cleanup behavior to remove the trigger label after the run completes.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
README.md Adds caller-side usage documentation and an example configuration.
.github/workflows/copy_proofread_review.yaml Introduces the reusable “copy proofread review” workflow and its steps/permissions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread .github/workflows/copy_proofread_review.yaml
Comment on lines +169 to +173
# Removes whichever label triggered the caller, so the label reflects "not currently queued" and
# re-adding it re-runs the review — the deliberate re-request action. Runs regardless of the review
# outcome, and is skipped when the caller was triggered by something other than a label.
if: always() && github.event.label.name != ''
uses: actions/github-script@v9
Comment thread .github/workflows/copy_proofread_review.yaml Outdated
stepskop and others added 4 commits August 5, 2026 12:38
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread .github/workflows/copy_proofread_review.yaml Outdated
@stepskop
stepskop merged commit d8e7c26 into main Aug 10, 2026
3 of 4 checks passed
@stepskop
stepskop deleted the feat/copy-proofread-review branch August 10, 2026 12:49
stepskop pushed a commit that referenced this pull request Aug 10, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.48.0](v0.47.0...v0.48.0)
(2026-08-10)


### Features

* add copy proofread review workflow
([#309](#309))
([d8e7c26](d8e7c26))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@raethlo raethlo added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-core-services Issues with this label are in the ownership of the core services team. validated Issues that are resolved and their solutions fulfill the acceptance criteria.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants