Skip to content

rewrite doc-pr to post comments directly via gh #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jth-nw merged 2 commits into from
Mar 10, 2026
Merged

rewrite doc-pr to post comments directly via gh #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01ea8ae
fix: rewrite doc-pr to post comments directly via gh
jth-nw Mar 10, 2026
03f87e4
Merge pull request #440 from netwrix/fix/doc-pr-workflow-rewrite
jth-nw Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions .claude/skills/doc-pr/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Only report issues on lines that were added or modified in this PR. Do not flag

## Output

Write the complete review to `.doc-pr-review.md` in the repository root using this exact structure:
After completing all three stages, post the review as a PR comment using `gh pr comment`. Build the comment body following this structure:

```markdown
## Documentation PR Review
Expand Down Expand Up @@ -102,9 +102,34 @@ Write the complete review to `.doc-pr-review.md` in the repository root using th
### Summary

N Vale issues, N Dale issues, N editorial suggestions across N files.

---

**What to do next:**

Comment `@claude` on this PR followed by your instructions to get help:

- `@claude fix all issues` — fix all Vale, Dale, and editorial issues
- `@claude fix only the Vale issues` — fix just the linting problems
- `@claude help improve the flow of this document` — get writing assistance
- `@claude explain the voice issues` — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

> Automated fixes are only available for branches in this repository, not forks.
```

After writing the review file, do NOT post a PR comment yourself. The workflow handles that.
Post the comment with:

```bash
gh pr comment $PR_NUMBER --repo $REPO --body "$REVIEW_BODY"
```

Use a heredoc or temporary file to avoid shell escaping issues with the multi-line body. For example:

```bash
gh pr comment $PR_NUMBER --repo $REPO --body-file /tmp/doc-pr-review.md
```

## Behavioral Notes

Expand Down
56 changes: 8 additions & 48 deletions .github/workflows/claude-doc-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ on:
types: [created]

jobs:
# ──────────────────────────────────────────────
# Job 1: Automated review on PR open or new push
# ──────────────────────────────────────────────
doc-review:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
Expand Down Expand Up @@ -59,7 +56,6 @@ jobs:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
PR_NUMBER=${{ github.event.pull_request.number }}
# Find and delete previous doc-pr review comments from the bot
COMMENT_IDS=$(gh api repos/${{ github.repository }}/issues/${PR_NUMBER}/comments \
--jq '[.[] | select(.user.login == "github-actions[bot]" and (.body | contains("Documentation PR Review"))) | .id] | .[]' 2>/dev/null || true)
for ID in $COMMENT_IDS; do
Expand All @@ -79,48 +75,16 @@ jobs:
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
show_full_output: true
prompt: |
Run the doc-pr review skill on this pull request.

Call the doc-pr review skill:
/doc-pr ${{ steps.changed-files.outputs.files }} ${{ github.event.pull_request.number }}
claude_args: |
--model claude-sonnet-4-5-20250929
--allowedTools "Read,Write,Glob,Grep,Bash(vale:*),Bash(gh pr view:*),Bash(gh pr diff:*),Skill(doc-pr),Skill(dale)"

- name: Post review comment
if: steps.changed-files.outputs.count > 0
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
REPO: ${{ github.repository }}
run: |
REVIEW_FILE=".doc-pr-review.md"
FOOTER=$'\n\n---\n\n'
FOOTER+=$'**What to do next:**\n\n'
FOOTER+=$'Comment `@claude` on this PR followed by your instructions to get help:\n\n'
FOOTER+=$'- `@claude fix all issues` — fix all Vale, Dale, and editorial issues\n'
FOOTER+=$'- `@claude fix only the Vale issues` — fix just the linting problems\n'
FOOTER+=$'- `@claude help improve the flow of this document` — get writing assistance\n'
FOOTER+=$'- `@claude explain the voice issues` — understand why something was flagged\n\n'
FOOTER+=$'You can ask Claude anything about the review or about Netwrix writing standards.\n\n'
FOOTER+=$'> Automated fixes are only available for branches in this repository, not forks.'

if [ -f "$REVIEW_FILE" ]; then
BODY=$(cat "$REVIEW_FILE")
else
BODY="## Documentation PR Review"$'\n\n'"No review was generated. Check the workflow logs for details."
fi

# Append footer
FULL_BODY="${BODY}${FOOTER}"

# Post as PR comment
gh pr comment "$PR_NUMBER" --repo "$REPO" --body "$FULL_BODY"
Context:
- REPO: ${{ github.repository }}
- PR_NUMBER: ${{ github.event.pull_request.number }}
- CHANGED_FILES: ${{ steps.changed-files.outputs.files }}
claude_args: '--allowedTools "Bash(vale:*),Bash(gh:*),Read,Glob,Grep,Skill(doc-pr),Skill(dale)"'

# ──────────────────────────────────────────────
# Job 2: @claude follow-up on PR comments
# ──────────────────────────────────────────────
doc-followup:
if: >-
github.event_name == 'issue_comment' &&
Expand All @@ -144,9 +108,8 @@ jobs:
BASE_BRANCH=$(echo "$PR_DATA" | jq -r '.baseRefName')
echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
echo "branch=$(echo "$PR_DATA" | jq -r '.headRefName')" >> "$GITHUB_OUTPUT"
echo "base_branch=$BASE_BRANCH" >> "$GITHUB_OUTPUT"
echo "is_fork=$(echo "$PR_DATA" | jq -r '.isCrossRepository')" >> "$GITHUB_OUTPUT"
# Check target branch here using the shell variable to avoid
# Check target branch using the shell variable to avoid
# re-interpolating the output via expressions (code injection risk).
if [ "$BASE_BRANCH" = "dev" ]; then
echo "targets_dev=true" >> "$GITHUB_OUTPUT"
Expand Down Expand Up @@ -184,9 +147,6 @@ jobs:
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
show_full_output: true
prompt: |
/doc-pr-fix ${{ steps.pr-info.outputs.number }} $COMMENT_BODY
claude_args: |
--model claude-sonnet-4-5-20250929
--allowedTools "Read,Write,Edit,Glob,Grep,Bash(vale:*),Bash(gh api:*),Bash(gh pr view:*),Bash(gh pr diff:*),Bash(gh pr comment:*),Bash(git config:*),Bash(git add:*),Bash(git commit:*),Bash(git push:*),Bash(git status:*),Bash(git diff:*),Skill(doc-pr-fix),Skill(dale)"
claude_args: '--allowedTools "Bash(vale:*),Bash(gh:*),Bash(git:*),Read,Write,Edit,Glob,Grep,Skill(doc-pr-fix),Skill(dale)"'
Loading