Skip to content

fix(skill): require names for GitHub workflow steps#64

Merged
khaliqgant merged 1 commit into
mainfrom
codex/fix-creategithubstep-name
Jun 1, 2026
Merged

fix(skill): require names for GitHub workflow steps#64
khaliqgant merged 1 commit into
mainfrom
codex/fix-creategithubstep-name

Conversation

@khaliqgant

@khaliqgant khaliqgant commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

  • require non-empty config name fields in createGitHubStep guidance
  • update the PR-shipping recipe and mistake table to reject id/command-shaped configs
  • use the current createBranch param name and bump writing-agent-relay-workflows to 1.6.17

Verification

  • inspected skill guidance with rg for stale createGitHubStep shorthand

Related: AgentWorkforce/ricky#144

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR bumps the writing-agent-relay-workflows package version to 1.6.17 across metadata files and updates skill documentation to clarify createGitHubStep configuration requirements, boot-time validation, PR creation examples, and PR URL capture practices.

Changes

Writing Agent Relay Workflows v1.6.17 Release

Layer / File(s) Summary
Version bump to 1.6.17
README.md, prpm.json
writing-agent-relay-workflows version is updated from 1.6.16 to 1.6.17 in the published skills table and package manifest.
createGitHubStep PR workflow guidance
skills/writing-agent-relay-workflows/SKILL.md
Documentation clarifies that createGitHubStep requires explicit non-empty name fields inside step configs, updates PR recipe examples to include names for create-branch, commit-change, and open-pr, expands the common mistakes section with boot-time validation requirements, clarifies builder compatibility for .step() handling of integration steps, reiterates using SDK primitives over direct gh pr create calls, and adds a checklist item to capture PR URL (html_url) deterministically.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • AgentWorkforce/skills#29: Both PRs update skills/writing-agent-relay-workflows/SKILL.md and prpm.json to refine createGitHubStep-based PR authoring guidance alongside corresponding version bumps.
  • AgentWorkforce/skills#42: Both PRs update skills/writing-agent-relay-workflows/SKILL.md around createGitHubStep PR creation and PR URL capture requirements as part of hardening workflow authoring.
  • AgentWorkforce/skills#26: Both PRs refine skills/writing-agent-relay-workflows/SKILL.md instructions on using GitHub primitives for PR opening workflows.

Poem

🐰 I hopped in to bump a tiny version line,
I nudged the docs so names align,
createGitHubStep now calls its name,
PR URLs captured—no more guessing game,
Carrots and commits, all neat and fine.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: requiring names for GitHub workflow steps, which aligns with updates to SKILL.md guidance and version bump.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description clearly describes the changeset: requiring names in createGitHubStep guidance, updating PR-shipping recipes, and bumping package version to 1.6.17, which aligns with the actual file changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/fix-creategithubstep-name

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the documentation for writing-agent-relay-workflows (bumping its version to 1.6.17 in README.md and prpm.json). The changes in SKILL.md clarify that createGitHubStep requires a matching non-empty name field inside its configuration object to pass SDK validation, and updates all code examples and common mistakes tables to reflect this requirement. There are no review comments to address, and I have no additional feedback to provide.

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 3 files

Re-trigger cubic

agent-relay-code Bot pushed a commit that referenced this pull request Jun 1, 2026
@agent-relay-code

Copy link
Copy Markdown
Contributor

Reviewed PR #64 and made fixes in skills/writing-agent-relay-workflows/SKILL.md.

Fixed:

  • Clarified createGitHubStep requires its own non-empty name.
  • Added builder compatibility guidance because released WorkflowBuilder.step() can reject integration steps.
  • Corrected the GitHub createBranch example from source: 'main' to fromBranch: 'main'.

Validated:

  • Parsed prpm.json, prpm.lock, and PR context JSON.
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17.
  • Ran targeted assertions over the updated doc text.

@agent-relay-code

Copy link
Copy Markdown
Contributor

pr-reviewer applied fixes — committed and pushed 69fb0ff to this PR. The notes below describe what changed.

Reviewed PR #64 and made fixes in skills/writing-agent-relay-workflows/SKILL.md.

Fixed:

  • Clarified createGitHubStep requires its own non-empty name.
  • Added builder compatibility guidance because released WorkflowBuilder.step() can reject integration steps.
  • Corrected the GitHub createBranch example from source: 'main' to fromBranch: 'main'.

Validated:

  • Parsed prpm.json, prpm.lock, and PR context JSON.
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17.
  • Ran targeted assertions over the updated doc text.

@agent-relay-code agent-relay-code Bot 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.

pr-reviewer applied fixes — committed and pushed 69fb0ff to this PR. The notes below describe what changed.

Reviewed PR #64 and made fixes in skills/writing-agent-relay-workflows/SKILL.md.

Fixed:

  • Clarified createGitHubStep requires its own non-empty name.
  • Added builder compatibility guidance because released WorkflowBuilder.step() can reject integration steps.
  • Corrected the GitHub createBranch example from source: 'main' to fromBranch: 'main'.

Validated:

  • Parsed prpm.json, prpm.lock, and PR context JSON.
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17.
  • Ran targeted assertions over the updated doc text.

@agent-relay-code

Copy link
Copy Markdown
Contributor

Reviewed PR #64 and fixed the main issue I found: the docs still centered a .step(..., createGitHubStep(...)) recipe that fails on strict WorkflowBuilder.step() SDK versions. I updated the skill to make the config/YAML integration-step path the primary recipe, kept .step() as a compatibility note only, and aligned the checklist/table wording.

Verification run locally:

  • JSON parse for prpm.json, prpm.lock, .workforce/context.json
  • local markdown link check for changed docs
  • SDK runtime config-construction check against @agent-relay/sdk@7.1.1
  • TypeScript check of the documented example against @agent-relay/sdk@7.1.1
  • prpm publish --list
  • prpm publish --dry-run --package writing-agent-relay-workflows was attempted but requires prpm login

@agent-relay-code

Copy link
Copy Markdown
Contributor

⚠️ pr-reviewer push failed (exit 1) — fixes were not applied to the PR. The notes below are advisory and were not pushed.

Reviewed PR #64 and fixed the main issue I found: the docs still centered a .step(..., createGitHubStep(...)) recipe that fails on strict WorkflowBuilder.step() SDK versions. I updated the skill to make the config/YAML integration-step path the primary recipe, kept .step() as a compatibility note only, and aligned the checklist/table wording.

Verification run locally:

  • JSON parse for prpm.json, prpm.lock, .workforce/context.json
  • local markdown link check for changed docs
  • SDK runtime config-construction check against @agent-relay/sdk@7.1.1
  • TypeScript check of the documented example against @agent-relay/sdk@7.1.1
  • prpm publish --list
  • prpm publish --dry-run --package writing-agent-relay-workflows was attempted but requires prpm login

@agent-relay-code agent-relay-code Bot 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.

⚠️ pr-reviewer push failed (exit 1) — fixes were not applied to the PR. The notes below are advisory and were not pushed.

Reviewed PR #64 and fixed the main issue I found: the docs still centered a .step(..., createGitHubStep(...)) recipe that fails on strict WorkflowBuilder.step() SDK versions. I updated the skill to make the config/YAML integration-step path the primary recipe, kept .step() as a compatibility note only, and aligned the checklist/table wording.

Verification run locally:

  • JSON parse for prpm.json, prpm.lock, .workforce/context.json
  • local markdown link check for changed docs
  • SDK runtime config-construction check against @agent-relay/sdk@7.1.1
  • TypeScript check of the documented example against @agent-relay/sdk@7.1.1
  • prpm publish --list
  • prpm publish --dry-run --package writing-agent-relay-workflows was attempted but requires prpm login

@khaliqgant khaliqgant merged commit ce3240d into main Jun 1, 2026
1 check passed
@khaliqgant khaliqgant deleted the codex/fix-creategithubstep-name branch June 1, 2026 17:59
@agent-relay-code

Copy link
Copy Markdown
Contributor

Reviewed PR #64 and applied the unresolved reviewer fix in skills/writing-agent-relay-workflows/SKILL.md.

Changed the GitHub PR-shipping recipe so createGitHubStep(...) is used as a full integration step inside workflows[].steps, not routed through strict WorkflowBuilder.step(). Added local GitHubStepExecutor wiring, YAML integration-step guidance, corrected the common mistakes table, and aligned the authoring rule wording.

Validation run locally:

  • Parsed prpm.json, prpm.lock, and .workforce/context.json
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17
  • Checked local markdown links in changed docs
  • Dry-ran the revised SDK config against @agent-relay/sdk@7.1.1
  • Ran npx prpm publish --list
  • Attempted npx prpm publish --dry-run --package writing-agent-relay-workflows, but it requires prpm login

@agent-relay-code

Copy link
Copy Markdown
Contributor

pr-reviewer applied fixes — committed and pushed 0f67575 to this PR. The notes below describe what changed.

Reviewed PR #64 and applied the unresolved reviewer fix in skills/writing-agent-relay-workflows/SKILL.md.

Changed the GitHub PR-shipping recipe so createGitHubStep(...) is used as a full integration step inside workflows[].steps, not routed through strict WorkflowBuilder.step(). Added local GitHubStepExecutor wiring, YAML integration-step guidance, corrected the common mistakes table, and aligned the authoring rule wording.

Validation run locally:

  • Parsed prpm.json, prpm.lock, and .workforce/context.json
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17
  • Checked local markdown links in changed docs
  • Dry-ran the revised SDK config against @agent-relay/sdk@7.1.1
  • Ran npx prpm publish --list
  • Attempted npx prpm publish --dry-run --package writing-agent-relay-workflows, but it requires prpm login

@agent-relay-code agent-relay-code Bot 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.

pr-reviewer applied fixes — committed and pushed 0f67575 to this PR. The notes below describe what changed.

Reviewed PR #64 and applied the unresolved reviewer fix in skills/writing-agent-relay-workflows/SKILL.md.

Changed the GitHub PR-shipping recipe so createGitHubStep(...) is used as a full integration step inside workflows[].steps, not routed through strict WorkflowBuilder.step(). Added local GitHubStepExecutor wiring, YAML integration-step guidance, corrected the common mistakes table, and aligned the authoring rule wording.

Validation run locally:

  • Parsed prpm.json, prpm.lock, and .workforce/context.json
  • Checked README/manifest version consistency for writing-agent-relay-workflows 1.6.17
  • Checked local markdown links in changed docs
  • Dry-ran the revised SDK config against @agent-relay/sdk@7.1.1
  • Ran npx prpm publish --list
  • Attempted npx prpm publish --dry-run --package writing-agent-relay-workflows, but it requires prpm login

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant