Repository navigation
Finish implementing Gradle plugin #221
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # CI for the Gradle plugin (refactor-first-gradle-plugin), which is excluded from the | ||
| # Maven reactor and built with its own Gradle wrapper. | ||
| name: Gradle Plugin CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| paths: | ||
| - 'refactor-first-gradle-plugin/**' | ||
| - 'report/**' | ||
| - '.github/workflows/gradle.yml' | ||
| pull_request: | ||
| branches: [ main ] | ||
| paths: | ||
| - 'refactor-first-gradle-plugin/**' | ||
| - 'report/**' | ||
| - '.github/workflows/gradle.yml' | ||
|
|
||
| jobs: | ||
| build: | ||
| strategy: | ||
| matrix: | ||
| os: [ ubuntu-latest, windows-latest ] | ||
| java-version: [ 17, 25 ] | ||
|
|
||
| runs-on: ${{ matrix.os }} | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| steps: | ||
| - name: Check out Git repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up JDK ${{ matrix.java-version }} | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| java-version: ${{ matrix.java-version }} | ||
| distribution: 'zulu' | ||
| cache: maven | ||
|
|
||
| # setup-gradle caches the Gradle user home and validates any wrapper jars | ||
| # found in the repository (including refactor-first-gradle-plugin/gradlew). | ||
| - name: Set up Gradle | ||
| uses: gradle/actions/setup-gradle@v6 | ||
|
|
||
| # The plugin consumes the (SNAPSHOT during development) report module and its | ||
| # transitives as real jars via mavenLocal(); install them first. | ||
| - name: Install report module to Maven local | ||
| run: mvn -B -q install -DskipTests -pl report -am | ||
|
|
||
| # Guard against version drift: gradle.properties must track the Maven project version. | ||
| - name: Check gradle.properties version matches Maven project version | ||
| run: | | ||
| mvnVersion=$(grep -m1 '<version>' pom.xml | sed -E 's:\s*</?version>::g') | ||
| gradleVersion=$(grep '^refactorFirstVersion=' refactor-first-gradle-plugin/gradle.properties | cut -d= -f2-) | ||
| echo "Maven project.version=$mvnVersion, gradle.properties refactorFirstVersion=$gradleVersion" | ||
| if [ "$mvnVersion" != "$gradleVersion" ]; then | ||
| echo "FATAL: version mismatch between pom.xml and refactor-first-gradle-plugin/gradle.properties" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Build and test the Gradle plugin | ||
| working-directory: refactor-first-gradle-plugin | ||
| run: ./gradlew clean build | ||
|
Comment on lines
+21
to
+66
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,7 +36,15 @@ jobs: | |
| distribution: 'temurin' | ||
| cache: maven | ||
| - name: Set release version | ||
| # Gradle plugin version sync: refactor-first-gradle-plugin/gradle.properties | ||
| # (refactorFirstVersion) must be bumped to the same version in the commits | ||
| # produced by this workflow. The Gradle plugin is published separately | ||
| # (./gradlew publishPlugins, maintainer-only) and must only be published | ||
| # AFTER this workflow has landed the matching `report` artifact on Maven | ||
| # Central — the plugin jar is thin and resolves `report` at runtime. | ||
| run: | | ||
| mvn --no-transfer-progress --batch-mode versions:set -DnewVersion=${{ github.event.inputs.version }} | ||
| sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${{ github.event.inputs.version }}/" refactor-first-gradle-plugin/gradle.properties | ||
|
Comment on lines
+46
to
+47
Contributor
There was a problem hiding this comment. 🔒 Security & Privacy | 🛡️ Detected with Advanced Tier | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -e
printf '%s\n' '--- changed workflow hunks ---'
git diff --unified=20 16a65561ea2230e3177ae8951b1b215846bc667a f6f294c0902554af4def40fd6f8674cf10fb68ee -- .github/workflows/release.yml
printf '%s\n' '--- reviewed workflow, numbered ---'
cat -n .github/workflows/release.yml
printf '%s\n' '--- workflow file status at revisions ---'
git show --no-patch --format='%H' 16a65561ea2230e3177ae8951b1b215846bc667a
git show --no-patch --format='%H' f6f294c0902554af4def40fd6f8674cf10fb68eeRepository: refactorfirst/RefactorFirst Length of output: 10680 🤖 get_repo_knowledge executed:
Length of output: 23770 Injection Reachability: External Pass workflow inputs through
Proposed fix+ env:
+ RELEASE_VERSION: ${{ github.event.inputs.version }}
run: |
- mvn --no-transfer-progress --batch-mode versions:set -DnewVersion=${{ github.event.inputs.version }}
- sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${{ github.event.inputs.version }}/" refactor-first-gradle-plugin/gradle.properties
+ [[ "$RELEASE_VERSION" =~ ^[0-9A-Za-z._-]+$ ]] || { echo "Invalid version"; exit 1; }
+ mvn --no-transfer-progress --batch-mode versions:set -DnewVersion="$RELEASE_VERSION"
+ sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${RELEASE_VERSION}/" refactor-first-gradle-plugin/gradle.properties
...
+ env:
+ RELEASE_NEXT_VERSION: ${{ github.event.inputs.nextVersion }}
run: |
- mvn --no-transfer-progress --batch-mode versions:set -DnewVersion=${{ github.event.inputs.nextVersion }}-SNAPSHOT
- sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${{ github.event.inputs.nextVersion }}-SNAPSHOT/" refactor-first-gradle-plugin/gradle.properties
+ [[ "$RELEASE_NEXT_VERSION" =~ ^[0-9A-Za-z._-]+$ ]] || { echo "Invalid next version"; exit 1; }
+ mvn --no-transfer-progress --batch-mode versions:set -DnewVersion="${RELEASE_NEXT_VERSION}-SNAPSHOT"
+ sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${RELEASE_NEXT_VERSION}-SNAPSHOT/" refactor-first-gradle-plugin/gradle.properties🧰 Tools🪛 zizmor (1.30.0)[error] 46-46: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [error] 47-47: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) 🤖 Prompt for AI Agents |
||
|
|
||
| - name: Commit & Push changes | ||
| uses: actions-js/push@master | ||
|
|
@@ -72,7 +80,9 @@ jobs: | |
| JRELEASER_DEPLOY_MAVEN_MAVENCENTRAL_RELEASE_DEPLOY_PASSWORD: ${{ secrets.JRELEASER_MAVENCENTRAL_SONATYPE_PASSWORD }} | ||
|
|
||
| - name: Set release version | ||
| run: | | ||
| mvn --no-transfer-progress --batch-mode versions:set -DnewVersion=${{ github.event.inputs.nextVersion }}-SNAPSHOT | ||
| sed -i "s/^refactorFirstVersion=.*/refactorFirstVersion=${{ github.event.inputs.nextVersion }}-SNAPSHOT/" refactor-first-gradle-plugin/gradle.properties | ||
|
|
||
| - name: Commit & Push changes | ||
| uses: actions-js/push@master | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -122,8 +122,45 @@ Specify with -D if running on the command line. e.g. ```-DbackEdgeAnalysisCount | |
| The Java 25 parser activates automatically when running on a JDK 25+ runtime (JEP 238 multi-release jar); there is no configuration flag for it. | ||
|
|
||
|
|
||
| ## Using the Gradle Plugin | ||
|
|
||
| Apply the plugin in `build.gradle.kts` (or `build.gradle`): | ||
|
|
||
| ```kotlin | ||
| plugins { | ||
| id("org.hjug.refactorfirst") version "0.11.0" | ||
| } | ||
| ``` | ||
|
|
||
| Tasks (run with `./gradlew <task>` on the project the plugin is applied to): | ||
|
|
||
| |Task| Output | | ||
| |----|----------------------------------------------------------------------| | ||
| |`refactorFirstHtmlReport`| `build/reports/refactorfirst/refactor-first-report.html` | | ||
| |`refactorFirstSimpleHtmlReport`| `build/reports/refactorfirst/refactor-first-report.html` | | ||
| |`refactorFirstCsvReport`| `build/reports/refactorfirst/RefFirst_P<name>_PV<version>_PD<date>.csv` | | ||
| |`refactorFirstJsonReport`| `.refactorfirst/refactor-first.json` | | ||
|
|
||
| Reports are always regenerated: the tasks never report `UP-TO-DATE` and are never loaded `FROM-CACHE`. | ||
|
|
||
| The `refactorFirst` extension accepts the same options as the Maven plugin (described above), plus an output override: | ||
|
|
||
| ```kotlin | ||
| refactorFirst { | ||
| showDetails = false | ||
| backEdgeAnalysisCount = 50 | ||
| analyzeCycles = true | ||
| minifyHtml = false | ||
| excludeTests = true | ||
| testSourceDirectory = "src/test" | ||
| projectName = "My Project" // defaults to the Gradle project name | ||
| projectVersion = "1.0-SNAPSHOT" // defaults to the Gradle project version | ||
| outputDirectory = "build/rf" // HTML/CSV only; the JSON report always writes to .refactorfirst | ||
| } | ||
| ``` | ||
|
|
||
| ## But my project layout isn't typical! | ||
| If your project layout isn't conventional, you can create a dummy POM file in the same directory as your .git directory to show your project's name in the report: | ||
|
|
||
| ```xml | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
|
|
@@ -188,7 +225,6 @@ There is still much to be done. Your feedback and collaboration would be greatl | |
| If you find this plugin useful, please star this repository and share with your friends & colleagues and on social media. | ||
|
|
||
| ## Future Plans | ||
| * Incorporate Unit Test coverage metrics to quickly identify the safety of refactoring classes. | ||
| * Incorporate additional meaningful metrics. | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔒 Security & Privacy | 🛡️ Detected with Advanced Tier | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: refactorfirst/RefactorFirst
Length of output: 7715
🤖 get_repo_knowledge executed:
get_repo_knowledge refactorfirst/RefactorFirst /tmp/coderabbit-repo-knowledge/refactorfirst-refactorfirst-8ce6ec94/architecture /tmp/coderabbit-repo-knowledge/refactorfirst-refactorfirst-8ce6ec94/conventionsLength of output: 16507
Security Misconfiguration
Reachability: External
Exploitability: Difficult
CWE: CWE-250
Restrict the workflow token to read-only contents.
This workflow does not declare
permissions, soGITHUB_TOKENaccess depends on repository or organization defaults. It checks out repository code and runs Maven and Gradle commands. Limit the token tocontents: read. Setpersist-credentials: falsewhen later steps do not need Git authentication.Proposed fix
📝 Committable suggestion
🧰 Tools
🪛 zizmor (1.30.0)
[warning] 20-67: overly broad permissions (excessive-permissions): default permissions used due to no permissions: block
(excessive-permissions)
View in Security blast radius
🤖 Prompt for AI Agents
Source: Linters/SAST tools