From 13cdc293826392308f76382dc954e7c3fb4d32bb Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Fri, 2 Dec 2022 18:24:06 -0800 Subject: [PATCH] [ci] Rename comment command from "/wpiformat" to "/format" (#4755) It now runs more than just wpiformat. --- .github/workflows/comment-command.yml | 6 +++--- README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/comment-command.yml b/.github/workflows/comment-command.yml index fc6474fbb3..f58ed18744 100644 --- a/.github/workflows/comment-command.yml +++ b/.github/workflows/comment-command.yml @@ -4,8 +4,8 @@ on: types: [ created ] jobs: - wpiformat: - if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/wpiformat') + format: + if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/format') runs-on: ubuntu-22.04 steps: - name: React Rocket @@ -60,5 +60,5 @@ jobs: git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" # Commit - git commit -am "wpiformat" + git commit -am "Formatting fixes" git push diff --git a/README.md b/README.md index 3ea4d3f83d..998d91f5d8 100644 --- a/README.md +++ b/README.md @@ -115,12 +115,12 @@ If you have installed the FRC Toolchain to a directory other than the default, o ### Formatting/linting +Once a PR has been submitted, formatting can be run in CI by commenting `/format` on the PR. A new commit will be pushed with the formatting changes. + #### wpiformat wpiformat can be executed anywhere in the repository via `py -3 -m wpiformat -clang 14` on Windows or `python3 -m wpiformat -clang 14` on other platforms. -Once a PR has been submitted, formatting can be run in CI by commenting `/wpiformat` on the PR. A new commit will be pushed with the formatting changes. - #### Java Code Quality Tools The Java code quality tools Checkstyle, PMD, and Spotless can be run via `./gradlew javaFormat`. SpotBugs can be run via the `spotbugsMain`, `spotbugsTest`, and `spotbugsDev` tasks. These tools will all be run automatically by the `build` task. To disable this behavior, pass the `-PskipJavaFormat` flag.