Skip to content

docs(#242): remove Jira remnants from custom agent guide#285

Open
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/242-fix-docs-building-custom-agents
Open

docs(#242): remove Jira remnants from custom agent guide#285
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/242-fix-docs-building-custom-agents

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown

Remove leftover Jira-specific code from the pre-script example that left an orphaned elif after the Jira branch was deleted. Replace the if/elif/fi block with a direct gh issue view call. Add missing issues: write permission to the workflow permissions block. Remove the unused issue_source workflow input and its references throughout the guide.


Closes #242

Post-script verification

  • Branch is not main/master (agent/242-fix-docs-building-custom-agents)
  • Secret scan passed (gitleaks — d8e3df7c018996e396c79b8ecd59e4145a628a6f..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Remove leftover Jira-specific code from the pre-script example
that left an orphaned elif after the Jira branch was deleted.
Replace the if/elif/fi block with a direct gh issue view call.
Add missing issues: write permission to the workflow permissions
block. Remove the unused issue_source workflow input and its
references throughout the guide.

Closes #242
@fullsend-ai-review

fullsend-ai-review Bot commented Jul 10, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:43 PM UTC · Completed 4:52 PM UTC
Commit: d8e3df7 · View workflow run →

@fullsend-ai-review

fullsend-ai-review Bot commented Jul 10, 2026

Copy link
Copy Markdown

Review — PR #285

Verdict: Approve

Summary

Clean documentation fix that removes dead Jira code from the custom agent guide (docs/guides/user/building-custom-agents.md). The change correctly addresses all three items from issue #242:

  1. Orphaned elif fixed — the entire if/elif/fi block (Jira vs GitHub branching) is replaced with a direct gh issue view call. This is a cleaner fix than converting elifif, since the Jira branch is dead code.
  2. issues: write permission added — merged into the existing single permissions: block in the example workflow.
  3. issue_source input removed — along with all references (ISSUE_SOURCE env var, workflow input, trigger docs, slash-command dispatch args).

The new REPO_FULL_NAME variable is consistently threaded through all three required locations: harness runner_env, workflow env block, and pre-script usage.

Dimensions reviewed

Dimension Result
Correctness ✅ Pre-script is syntactically valid bash. YAML structure correct (single permissions: block). REPO_FULL_NAME consistently threaded.
Security ✅ No secrets, no injection vectors. permissions: change is in a documentation example, not an actual workflow. Removing the Jira Basic auth pattern is a positive change.
Intent & coherence ✅ Scope matches issue #242 authorization. REPO_FULL_NAME additions are necessary technical consequences, not scope creep. Commit prefix docs(#242): follows COMMITS.md conventions.
Docs currency ✅ No stale references to removed identifiers (ISSUE_SOURCE, issue_source) remain after the diff.

Low-severity note

Residual Jira mention in prose (line 223): The sandbox policy design principles section still reads "Never allow Jira/internal APIs from the sandbox. All Jira reads happen in pre-scripts; all Jira writes happen in post-scripts." With all Jira example code removed from the guide, the Jira-specific framing is slightly orphaned. The underlying principle (external system access belongs in pre/post scripts) remains valid. Consider simplifying to reference "internal/external APIs" generically in a future pass.

Previous run

Review — PR #285

Verdict: approve · docs-only fix · 1 file · +7 −21

Summary

Clean documentation fix that addresses issue #242. The PR:

  1. Removes the broken if/elif/fi Jira/GitHub branching in the pre-script example, replacing it with a direct gh issue view call.
  2. Adds issues: write to the example workflow permissions block (consistent with every real fullsend agent workflow in the repo).
  3. Removes the orphaned issue_source workflow input and all of its references (explicitly authorized as optional work in issue [RTK+Ponytail] Fix elif syntax error and duplicate permissions block in building-custom-agents guide #242).
  4. Updates trigger documentation (UI instructions, CLI examples, slash-command dispatch) for consistency.

All ISSUE_SOURCE / issue_source references are fully cleaned up across the file. No stale references remain.

Dimension results

Dimension Result
Correctness ✅ 1 low pre-existing gap (see below)
Security ✅ No findings — issues: write matches repo convention
Intent & coherence ✅ Properly scoped to issue #242
Style ✅ No findings
Docs currency ✅ No stale references
Cross-repo contracts ⏭ Skipped (no APIs modified)

Low findings

[pre-existing-gap] docs/guides/user/building-custom-agents.md — The pre-script example uses $REPO_FULL_NAME (line 265 post-PR) but neither the example harness runner_env nor the example workflow env block defines it. With set -euo pipefail the example script would fail on an unset variable. This is a pre-existing gap — the variable was already used in the elif branch before this PR — and is outside the scope of issue #242. The customizing-agents.md guide does show REPO_FULL_NAME: "${REPO_FULL_NAME}" in its harness example, so the fix would be adding the same line to this guide's harness and workflow examples. A follow-up issue would be appropriate.

Notes

  • The general security guidance at line 223 ("Never allow Jira/internal APIs from the sandbox") remains valid as architectural advice even with Jira examples removed — it applies to any future external integration.
  • The issues: write permission addition matches the pattern in qualityflow.yaml, reusable-review.yml, reusable-fix.yml, reusable-triage.yml, and all scaffold workflows. The guide's post-script section explicitly describes issue-writing as a post-script action (line 104).

Labels: PR modifies user-facing documentation guides

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge documentation Improvements or additions to documentation labels Jul 10, 2026
@guyoron1

Copy link
Copy Markdown
Owner

/fs-fix

@fullsend-ai-coder

fullsend-ai-coder Bot commented Jul 10, 2026

Copy link
Copy Markdown
Author

🤖 Finished Fix · ✅ Success · Started 5:38 PM UTC · Completed 5:45 PM UTC
Commit: d8e3df7 · View workflow run →

The pre-script example uses $REPO_FULL_NAME but the example harness
runner_env and workflow env block did not define it. With set -euo
pipefail the example script would fail on the unset variable. Add it
to both locations, matching the pattern in customizing-agents.md.

Addresses review feedback on #285
@fullsend-ai-coder

Copy link
Copy Markdown
Author

🔧 Fix agent — iteration 1 (human-triggered)

Added missing REPO_FULL_NAME variable to example harness runner_env and workflow env block. The pre-script example uses $REPO_FULL_NAME but neither the harness nor workflow defined it, which would cause a failure under set -euo pipefail.

Fixed (1):

  1. pre-script uses $REPO_FULL_NAME but harness/workflow never define it: Added REPO_FULL_NAME to the example harness runner_env and workflow env block, matching the pattern in customizing-agents.md

Tests: passed

Updated by fullsend fix agent

@fullsend-ai-review

fullsend-ai-review Bot commented Jul 10, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 5:49 PM UTC · Completed 5:58 PM UTC
Commit: d8e3df7 · View workflow run →

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge and removed ready-for-merge All reviewers approved — ready to merge labels Jul 10, 2026
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-merge All reviewers approved — ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RTK+Ponytail] Fix elif syntax error and duplicate permissions block in building-custom-agents guide

1 participant