Skip to content

docs(#209): add CI & Packaging section to AGENTS.md - #210

Open
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/209-ci-packaging-agents-md
Open

fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/209-ci-packaging-agents-md

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Adds a new CI & Packaging section to AGENTS.md documenting the constraint that package.json dependencies must use npm-compatible version specifiers.
  • The verify-plugin-export.yaml workflow builds with yarn pack then installs via npm install -g, so Yarn-specific protocols (patch:, portal:, workspace:) break CI.
  • Lists the 9 plugin workspaces verified by the workflow for additional context.

Context

This was identified from PR #205 where a patch: protocol dependency caused all 9 Verify Plugin Export jobs to fail. The review agent missed the npm incompatibility because AGENTS.md had no documentation about CI packaging constraints.

Testing

  • Documentation-only change — no code behavior affected.
  • Verified the new section is placed logically between "Pattern References" and "PR Conventions".
  • Content matches the exact constraint from verify-plugin-export.yaml line 97 (npm install -g ./rhdh-cli/rhdh-cli.tgz).

Closes #209

Post-script verification

  • Branch is not main/master (agent/209-ci-packaging-agents-md)
  • Secret scan passed (gitleaks — 7dac1979668716aafb853607ecfc253777515467..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add a new CI & Packaging section to AGENTS.md documenting that
the verify-plugin-export.yaml workflow installs the packed
tarball via npm install -g, so package.json dependencies must
use npm-compatible version specifiers. This gives the review
agent context to flag Yarn-specific protocols (patch:, portal:,
workspace:) that would break npm installation.

Closes #209

Assisted-by: claude-opus-4-6
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Sep 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "docs(#209): add CI & Packaging section to AGENTS.md". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat
 - fix
 - chore
 - docs
 - style
 - refactor
 - perf
 - test
 - revert

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 15, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:15 PM UTC · Completed 4:29 PM UTC

Commit: 0a25abe · View workflow run →

Runtime: claude · Model: sonnet → claude-sonnet-4-6 · Effort: high · Cost: $1.93

@fullsend-ai-review fullsend-ai-review Bot added the risk/moderate PR risk: moderate label Sep 15, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Sep 15, 2026

Copy link
Copy Markdown

Risk Assessment: moderate (2/5)

Details

Signals are unchanged from prior assessment — small documentation-only addition to the single protected path AGENTS.md by a bot with a well-scoped issue and fully met acceptance criteria; re-review anchoring preserves the prior moderate score of 2.

Previous run

Risk Assessment: moderate (2/5)

Details

Small documentation-only addition to a protected path (AGENTS.md) by a bot with clear issue linkage and fully met acceptance criteria; the single protected-path flag and mild git-history contention on AGENTS.md elevate this slightly above low but no significant risk factors are present.

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review

Findings

High

  • [naming-convention] N/A — PR title docs(#209): add CI & Packaging section to AGENTS.md still places an issue reference in the Conventional Commits scope position. AGENTS.md line 59 (the file this PR modifies) explicitly prohibits # in scopes: scopes must match [\w$.\-* ]* — no #, @, or other special characters. This finding was raised in the prior review and is not yet addressed; the Conventional Commits CI check remains failing, blocking merge.
    Remediation: Rename the PR title to docs: add CI & Packaging section to AGENTS.md (drop the scope entirely, or use a plain scope word such as agents). The issue reference is already correctly placed as Closes #209 in the PR body.

Medium


Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR
Previous run

Review

Findings

High

  • [naming-convention] N/A — PR title docs(#209): add CI & Packaging section to AGENTS.md places an issue reference in the Conventional Commits scope position. The PR Conventions section of this same file (line 57) explicitly prohibits # in scopes: "Scopes are optional. If used, they must match [\w$.\-* ]* — no #, @, or other special characters. Do not put issue references (e.g., #187) in the scope position; reference issues in the PR body with Closes #N instead." The Conventional Commits CI check is confirmed failing for this PR, blocking merge.
    Remediation: Rename the PR title to docs: add CI & Packaging section to AGENTS.md (drop the scope entirely, or use a plain scope word such as agents). The issue reference is already correctly placed as Closes #209 in the PR body.

Medium

Low

  • [technical-accuracy] AGENTS.md:48npm install -g <tarball> only resolves and installs dependencies; devDependencies are never fetched during a global npm install of a tarball. A Yarn-specific protocol (patch:, portal:, workspace:) that appears only in devDependencies would not cause the Verify Plugin Export workflow to fail. The added text warns against these protocols in both dependencies and devDependencies, overstating the hard constraint for the devDependencies field.
    Remediation: Tighten the constraint to apply to the dependencies field only (where npm install -g actually reads and resolves specifiers). Note devDependencies as a best-practice recommendation rather than a CI-breaking hard requirement.

Labels: PR modifies project documentation file (AGENTS.md)


Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-review fullsend-ai-review Bot added the documentation Improvements or additions to documentation label Sep 15, 2026
@fullsend-ai-coder

fullsend-ai-coder Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 4:31 PM UTC · Completed 4:36 PM UTC

Commit: 0a25abe · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $0.90

Clarify that the npm-compatible version specifier requirement applies to
the `dependencies` field (which `npm install -g` resolves). Note
`devDependencies` as a best-practice recommendation rather than a
CI-breaking hard constraint, since global tarball installs do not
resolve devDependencies.

Addresses #210

Assisted-by: claude-sonnet-4-6
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 1 (bot-triggered)

Addressed 3 review findings: (1) PR title naming-convention violation identified but could not be fixed due to sandbox API restrictions — requires manual title update; (2) protected-path observation acknowledged as informational; (3) devDependencies constraint in AGENTS.md tightened to correctly distinguish CI-breaking (dependencies) from best-practice (devDependencies) guidance.

Fixed (2):

  1. PR title places issue reference in Conventional Commits scope position (N/A): The PR title should be changed from docs(#209): add CI & Packaging section to AGENTS.md to docs: add CI & Packaging section to AGENTS.md. The fix agent could not apply this change due to sandbox API restrictions (GraphQL endpoint blocked). The PR author or a maintainer should update the title manually to unblock the Conventional Commits CI check.
  2. devDependencies constraint overstated in CI & Packaging docs (AGENTS.md): Tightened the npm-compatible version specifier constraint to apply to the dependencies field only, since npm install -g does not resolve devDependencies. The devDependencies guidance is now noted as a best-practice recommendation for consistency rather than a CI-breaking hard requirement.

Disagreed (1):

  1. AGENTS.md is a protected path requiring human approval: This is an informational observation, not an actionable code finding. The PR already modifies AGENTS.md as its stated purpose. Human approval is a process requirement that cannot be addressed by code changes.

Tests: passed

Decision points
  • PR title fix requires forge API access unavailable in sandbox (alternatives: Fix via gh pr edit --title (blocked by sandbox policy), Record limitation for post-script or manual fix; rationale: The sandbox network policy blocks GraphQL mutations. The finding is valid and the fix is straightforward, but must be applied outside the sandbox.)

Next steps:

  • /fs-review — request a re-review of the changes
  • /fs-fix <your instruction> — run another fix pass with specific guidance
  • Push commits directly — review re-runs automatically on push
    Updated by fullsend fix agent

@sonarqubecloud

Copy link
Copy Markdown

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 15, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:37 PM UTC · Completed 4:50 PM UTC

Commit: 99f9c7e · View workflow run →

Runtime: claude · Model: sonnet → claude-sonnet-4-6 · Effort: high · Cost: $2.19

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review comment for full details.

@fullsend-ai-coder

fullsend-ai-coder Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 4:51 PM UTC · Completed 4:55 PM UTC

Commit: 99f9c7e · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $0.84

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 2 (bot-triggered)

Both review findings are non-code issues. Finding 1 (PR title naming convention) is valid but cannot be fixed from within the sandbox due to API restrictions — the title needs to be changed from docs(#209): to docs: by the post-script or a maintainer. Finding 2 (protected path) is an informational process observation, not an actionable code finding. No code changes were needed; the AGENTS.md content from iteration 1 is correct.

Fixed (1):

  1. PR title places issue reference (Add CI packaging constraints to AGENTS.md so review agent catches npm/Yarn incompatibilities #209) in Conventional Commits scope position, violating the scope pattern (N/A): The PR title should be changed from docs(#209): add CI & Packaging section to AGENTS.md to docs: add CI & Packaging section to AGENTS.md. Both gh pr edit --title (GraphQL) and the REST API PATCH /repos/.../pulls/210 are blocked by sandbox network policy. This was also attempted in iteration 1 with the same result. The fix requires action outside the sandbox — the post-script or a maintainer should update the PR title to unblock the Conventional Commits CI check.

Disagreed (1):

  1. AGENTS.md is a protected path requiring human approval: This is an informational observation about the review process, not an actionable code finding. The PR's stated purpose is to modify AGENTS.md. Human approval is a process requirement that cannot be addressed by code changes — it requires a human reviewer to approve the PR.

Tests: passed

Decision points
  • PR title fix requires forge API access unavailable in sandbox (alternatives: Fix via gh pr edit --title (blocked by GraphQL policy), Fix via REST API PATCH (blocked by REST policy), Record limitation for post-script or manual fix; rationale: Both GraphQL and REST API endpoints are blocked by sandbox network policy. The finding is valid and the fix is straightforward, but must be applied outside the sandbox. This is the second iteration encountering this same limitation.)

Next steps:

  • /fs-review — request a re-review of the changes
  • /fs-fix <your instruction> — run another fix pass with specific guidance
  • Push commits directly — review re-runs automatically on push
    Updated by fullsend fix agent

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 ready-for-review Triggers review agent dispatch risk/moderate PR risk: moderate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CI packaging constraints to AGENTS.md so review agent catches npm/Yarn incompatibilities

0 participants