Conversation
Add a project-local Codex skill for triggering OpenXiangShan/GEM5 manual-perf workflow. The skill checks gh availability and auth, asks for workflow inputs, warns that only kmhv3.py has been verified in this flow, and requires post-trigger run validation. Change-Id: I78d822a03cd58a2986f6cf8656437482f4e75cc7
📝 WalkthroughWalkthroughIntroduces documentation and configuration for a new gem5-manual-perf-trigger skill, including a step-by-step workflow guide and an OpenAI agent interface definition for triggering remote GitHub Actions workflows locally. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can generate a title for your PR based on the changes.Add |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.codex/skills/gem5-manual-perf-trigger/SKILL.md (1)
84-86: Clarify--refandbranchinput semantics for tag/SHA triggers.The documentation permits tag/SHA for
--ref(line 84), but lines 115–117 suggestbranchinput should mirror--ref. This creates misconfiguration risk: when--refis a tag or SHA, thebranchinput should not automatically replicate it, as--refcontrols where the workflow runs from whilebranchinput (if used) should specify what the workflow operates on.Update the documentation to clarify:
- When
--refis a branch:branchinput can typically match it- When
--refis a tag/SHA:branchinput requires explicit user confirmation and should not default to the same value🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.codex/skills/gem5-manual-perf-trigger/SKILL.md around lines 84 - 86, Update the SKILL.md documentation to clearly distinguish the semantics of the --ref flag vs the branch input: state that --ref may accept a branch name, tag or commit SHA and controls where the workflow is checked out/run from, while the branch input (if present) controls what the workflow operates on; specify that when --ref is a branch the branch input can usually mirror it, but when --ref is a tag or SHA the branch input must be explicitly provided and should not default to the same value; update the lines around the current brief “目标分支、tag 或 SHA:通常是当前分支” and the paragraphs that mirror --ref to reflect this explicit guidance for --ref and branch inputs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.codex/skills/gem5-manual-perf-trigger/SKILL.md:
- Around line 121-137: The docs call gh run view <run-id> without explaining how
to obtain the run id; update the procedure to capture the workflow run id after
triggering by using the GitHub API with return_run_details=true (e.g., POST to
repos/OpenXiangShan/GEM5/actions/workflows/manual-perf.yml/dispatches) and store
it in a RUN_ID variable, then use gh run view $RUN_ID --repo OpenXiangShan/GEM5
(and gh run view $RUN_ID --repo OpenXiangShan/GEM5 --json
status,conclusion,url,name,headBranch,headSha) to validate the run exists and
its status.
---
Nitpick comments:
In @.codex/skills/gem5-manual-perf-trigger/SKILL.md:
- Around line 84-86: Update the SKILL.md documentation to clearly distinguish
the semantics of the --ref flag vs the branch input: state that --ref may accept
a branch name, tag or commit SHA and controls where the workflow is checked
out/run from, while the branch input (if present) controls what the workflow
operates on; specify that when --ref is a branch the branch input can usually
mirror it, but when --ref is a tag or SHA the branch input must be explicitly
provided and should not default to the same value; update the lines around the
current brief “目标分支、tag 或 SHA:通常是当前分支” and the paragraphs that mirror --ref to
reflect this explicit guidance for --ref and branch inputs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 36f5bc8c-f6f3-4361-b450-a89c7d3d5079
📒 Files selected for processing (2)
.codex/skills/gem5-manual-perf-trigger/SKILL.md.codex/skills/gem5-manual-perf-trigger/agents/openai.yaml
🚀 Coremark Smoke Test Results
✅ Difftest smoke test passed! |
Summary
USAGE
gh [flags]
CORE COMMANDS
auth: Authenticate gh and git with GitHub
browse: Open repositories, issues, pull requests, and more in the browser
codespace: Connect to and manage codespaces
gist: Manage gists
issue: Manage issues
org: Manage organizations
pr: Manage pull requests
project: Work with GitHub Projects.
release: Manage releases
repo: Manage repositories
GITHUB ACTIONS COMMANDS
cache: Manage GitHub Actions caches
run: View details about workflow runs
workflow: View details about GitHub Actions workflows
ALIAS COMMANDS
co: Alias for "pr checkout"
ADDITIONAL COMMANDS
agent-task: Work with agent tasks (preview)
alias: Create command shortcuts
api: Make an authenticated GitHub API request
attestation: Work with artifact attestations
completion: Generate shell completion scripts
config: Manage configuration for gh
copilot: Run the GitHub Copilot CLI (preview)
extension: Manage gh extensions
gpg-key: Manage GPG keys
label: Manage labels
licenses: View third-party license information
preview: Execute previews for gh features
ruleset: View info about repo rulesets
search: Search for repositories, issues, and pull requests
secret: Manage GitHub secrets
ssh-key: Manage SSH keys
status: Print information about relevant issues, pull requests, and notifications across repositories
variable: Manage GitHub Actions variables
HELP TOPICS
accessibility: Learn about GitHub CLI's accessibility experiences
actions: Learn about working with GitHub Actions
environment: Environment variables that can be used with gh
exit-codes: Exit codes used by gh
formatting: Formatting options for JSON data exported from gh
mintty: Information about using gh with MinTTY
reference: A comprehensive reference of all gh commands
FLAGS
--help Show help for command
--version Show gh version
EXAMPLES
$ gh issue create
$ gh repo clone cli/cli
$ gh pr checkout 321
LEARN MORE
Use
gh <command> <subcommand> --helpfor more information about a command.Read the manual at https://cli.github.com/manual
Learn about exit codes using
gh help exit-codesLearn about accessibility experiences using
gh help accessibilityinstallation and auth before triggeringNotes
Summary by CodeRabbit
Documentation
New Features