Skip to content

misc: add manual perf trigger skill#796

Merged
jensen-yan merged 1 commit intoxs-devfrom
skill-gem5-manual-perf-trigger
Mar 20, 2026
Merged

misc: add manual perf trigger skill#796
jensen-yan merged 1 commit intoxs-devfrom
skill-gem5-manual-perf-trigger

Conversation

@Ergou-ren
Copy link
Copy Markdown
Collaborator

@Ergou-ren Ergou-ren commented Mar 17, 2026

Summary

  • add a project-local Codex skill for triggering
  • require checking Work seamlessly with GitHub from the command line.

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> --help for more information about a command.
Read the manual at https://cli.github.com/manual
Learn about exit codes using gh help exit-codes
Learn about accessibility experiences using gh help accessibility installation and auth before triggering

  • require confirming workflow inputs and validating the created Actions run after dispatch

Notes

  • the flow has been exercised with
  • other configurations exist in workflow inputs but are not yet verified in this skill flow

Summary by CodeRabbit

  • Documentation

    • Added comprehensive documentation for GEM5 Manual Perf Trigger, including workflow overview, prerequisites, step-by-step instructions, failure handling, and usage examples.
  • New Features

    • Introduced GEM5 Manual Perf Trigger interface supporting remote GitHub Actions workflow triggering with configurable branch, configuration, and benchmark parameters.

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
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 17, 2026

📝 Walkthrough

Walkthrough

Introduces 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

Cohort / File(s) Summary
Skill Documentation
.codex/skills/gem5-manual-perf-trigger/SKILL.md
Comprehensive guide outlining end-to-end workflow for triggering manual-perf GitHub Actions remotely via gh command-line tool, including prerequisites, step-by-step process, failure handling, and examples.
Agent Interface Configuration
.codex/skills/gem5-manual-perf-trigger/agents/openai.yaml
Configuration defining OpenAI agent interface with display name, description, and default prompt for GEM5 manual performance workflow triggering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • Yakkhini
  • CJ362ff

Poem

🐰 A skill hops into place with care,
Documentation fluffy and fair,
GEM5 workflows await the call,
Agent interfaces, configured tall,
GitHub Actions triggered with flair! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title uses the vague term 'misc' which doesn't convey meaningful information about the changeset. While 'manual perf trigger skill' describes what was added, the 'misc:' prefix is non-descriptive and violates the guidance against generic terms. Replace 'misc:' with a more descriptive prefix or context (e.g., 'chore: add manual perf trigger skill' or 'feat: add gem5 manual perf trigger skill') to clarify the nature and purpose of the change.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skill-gem5-manual-perf-trigger
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.codex/skills/gem5-manual-perf-trigger/SKILL.md (1)

84-86: Clarify --ref and branch input semantics for tag/SHA triggers.

The documentation permits tag/SHA for --ref (line 84), but lines 115–117 suggest branch input should mirror --ref. This creates misconfiguration risk: when --ref is a tag or SHA, the branch input should not automatically replicate it, as --ref controls where the workflow runs from while branch input (if used) should specify what the workflow operates on.

Update the documentation to clarify:

  • When --ref is a branch: branch input can typically match it
  • When --ref is a tag/SHA: branch input 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

📥 Commits

Reviewing files that changed from the base of the PR and between 6b87b99 and 69ec57e.

📒 Files selected for processing (2)
  • .codex/skills/gem5-manual-perf-trigger/SKILL.md
  • .codex/skills/gem5-manual-perf-trigger/agents/openai.yaml

@github-actions
Copy link
Copy Markdown

🚀 Coremark Smoke Test Results

Branch IPC Change
Base (xs-dev) 2.2665 -
This PR 2.2665 ➡️ 0.0000 (0.00%)

✅ Difftest smoke test passed!

@jensen-yan jensen-yan merged commit be14778 into xs-dev Mar 20, 2026
2 checks passed
@jensen-yan jensen-yan deleted the skill-gem5-manual-perf-trigger branch March 20, 2026 08:48
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.

2 participants