Production-grade, all-in-one GitHub Reusable Workflow designed for FIRST Robotics Competition (FRC) Java teams.
- Automated WPILib Year & Java Detection
- Robust Gradle CI
- JUnit Test Artifacts & Annotations
- Local On-Runner AI Code Review
- Sticky PR Comments
- Optional Slack Notifications
To use this reusable workflow in your robot repository, create a caller workflow file such as .github/workflows/ci.yml:
name: Robot CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
frc-ci:
name: FRC CI
uses: coder11v/frcworkflows/.github/workflows/frc-ci.yml@v1.1
permissions:
contents: read
checks: write
pull-requests: write
issues: write
with:
fallback-year: "2026"
enable-ai-review: true
slack-thread-ts: "" # Optional Slack thread timestamp
ollama-model: "qwen2.5-coder:1.5b"
secrets:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # Optional| Input | Type | Default | Description |
|---|---|---|---|
fallback-year |
string | "2026" |
Fallback WPILib season year if unable to detect from .wpilib/wpilib_preferences.json or build.gradle. |
enable-ai-review |
boolean | true |
Whether to run on-runner Ollama AI code review and post/update sticky comments on pull requests. |
slack-thread-ts |
string | "" |
Slack message thread timestamp (thread_ts) if notifications should reply inside an existing thread. |
ollama-model |
string | "qwen2.5-coder:1.5b" |
Ollama model identifier to pull and run for code review. |
| Secret | Required | Description |
|---|---|---|
SLACK_WEBHOOK_URL |
No | Slack incoming webhook URL for CI notifications. If omitted, Slack notifications are cleanly skipped. |
BOT_APP_PRIVATE_KEY |
No | GitHub App private key (.pem format) to author PR comments as a custom bot identity. Used together with bot-app-id. |
COMMENT_TOKEN |
No | Optional pre-generated token (or PAT) to author PR comments instead of github-actions[bot]. Defaults to GITHUB_TOKEN. |
By default, comments are posted by github-actions[bot]. To have comments posted under a custom bot identity (e.g. 5171-bot[bot] or sad-guy-bot[bot]) with your custom team avatar:
- Create a GitHub App:
- Go to Settings > Developer Settings > GitHub Apps > New GitHub App.
- Name your App and upload your avatar.
- Disable Webhooks (uncheck "Active").
- Under Repository Permissions, grant:
Pull requests: Read & writeIssues: Read & write
- Click Create GitHub App.
- Note the App ID and generate/download a Private Key (
.pemfile).
- Install the App:
- Under your App's settings, click Install App and select your robot repositories (or entire organization).
- Add Secret in Robot Repository (or Organization):
- Add
BOT_APP_PRIVATE_KEYwith the entire content of the.pemfile.
- Add
- Call the Workflow Directly:
jobs: frc-ci: name: FRC CI uses: coder11v/frcworkflows/.github/workflows/frc-ci.yml@v1.1 permissions: contents: write checks: write pull-requests: write issues: write with: fallback-year: "2026" enable-ai-review: true bot-app-id: ${{ vars.BOT_APP_ID || '5648265' }} secrets: SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} BOT_APP_PRIVATE_KEY: ${{ secrets.BOT_APP_PRIVATE_KEY }}
Ensure the calling job or workflow includes the following GitHub token permissions:
permissions:
contents: read # Check out repository and read commit history
checks: write # Publish JUnit test result annotations via Checks API
pull-requests: write # Create and update sticky PR review comments
issues: write # Required by GitHub API for pull request comment managementCreated and maintained by Veer Bajaj (@coder11v).
Distributed under the Apache License 2.0. See the LICENSE file for details. All derivative works, copies, and downstream consumers must retain the copyright notice and attribution specified in NOTICE.