Improved auto-formatter behavior (#781)

* Attempting improvements * Added git config info * Added check for modified files * Modifying GitHub Token use * Temporarily changing user for my fork * Change fork checking and repo name retrieval * Changing back Testing these changes on my fork now doesn't work * Removed distribution * Didn't properly change back * More testing * Testing to see if this works...? * Update java-autoformat.yml * Set upstream * Changing back to Bram * Changing method to create pull request * Modifying job execution conditions * Automated Java code formatting changes * Update java-autoformat.yml Changed branch name to be unique and fail task on master PRs * More debugging * More debugging * More changes * Adding bad formatting for testing * Automated Java code formatting changes * Even more debugging * Bug fixing * EVEN MORE DEBUGGING * Debugging... * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Update java-autoformat.yml * Bad formatting for testing * Update java-autoformat.yml * Update java-autoformat.yml * Automated Java code formatting changes * Update java-autoformat.yml * DEBUG * Trying different way to check for modified files * Bad formatting for testing * Automated Java code formatting changes * More changes + more testing * Automated Java code formatting changes --------- Co-authored-by: Bram van Heuveln <[email protected]>
Bram-Hub · Mar 29, 2024 · 6054db7 · 6054db7
1 parent 838272e
commit 6054db7
Show file tree

Hide file tree

Showing 2 changed files with 113 additions and 58 deletions.
diff --git a/.github/workflows/java-autoformat.yml b/.github/workflows/java-autoformat.yml
@@ -2,8 +2,10 @@ name: Java Code Auto Format
 on: pull_request
 
 jobs:
-  format:
-    if: github.event.pull_request.head.repo.full_name == github.repository
+  format_dev:
+    if: |
+      github.event.pull_request.head.ref == 'dev' && 
+      github.event.pull_request.head.repo.full_name == github.repository
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -15,7 +17,6 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: 21
-          distribution: temurin
 
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
@@ -28,7 +29,58 @@ jobs:
 
       - name: Check for modified files
         id: git-check
-        run: echo "modified=$(if git diff-index --quiet HEAD --; then echo "false"; else echo "true"; fi)" >> $GITHUB_OUTPUT
+        run: echo "modified=$(if [[ -n $(git status -s) ]]; then echo "true"; else echo "false"; fi)" >> $GITHUB_OUTPUT
+
+      - name: Create temporary branch and pull request
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          git config --global user.name 'Bram van Heuveln'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          branch_name="auto-format-code-$(date +%s)"
+          git checkout -b $branch_name
+          ./gradlew :spotlessApply
+          git add .
+          git commit -am "Automated Java code formatting changes"
+          git push --set-upstream origin $branch_name
+          gh pr create -B dev -H $branch_name --title 'Automated Java code formatting changes' --body 'This pull request contains automated code formatting changes.' --reviewer ${{ github.actor }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Must approve auto-format pull request
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          echo "Please review and approve the appropriate auto-format-code pull request."
+          exit 1
+
+  format_pull_request_to_dev:
+    if: |
+      github.event.pull_request.base.ref == 'dev' && 
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Run spotless
+        run: ./gradlew :spotlessApply
+
+      - name: Check for modified files
+        id: git-check
+        run: echo "modified=$(if [[ -n $(git status -s) ]]; then echo "true"; else echo "false"; fi)" >> $GITHUB_OUTPUT
 
       - name: Push changes
         if: steps.git-check.outputs.modified == 'true'
@@ -37,4 +89,5 @@ jobs:
           git config --global user.email '[email protected]'
           git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
           git add .
-          git diff --cached --exit-code || git commit -am "Automated Java code formatting changes" && git push
+          git commit -am "Automated Java code formatting changes"
+          git push
diff --git a/src/main/java/edu/rpi/legup/model/gameboard/GridRegion.java b/src/main/java/edu/rpi/legup/model/gameboard/GridRegion.java
@@ -1,53 +1,55 @@
-package edu.rpi.legup.model.gameboard;
-
-import java.util.ArrayList;
-import java.util.List;
-
-public abstract class GridRegion<T> {
-
-    protected List<T> regionCells;
-
-    /**
-     * Region Constructor
-     */
-    public GridRegion() {
-        this.regionCells = new ArrayList<>();
-    }
-
-    /**
-     * Adds the cell to the region
-     * @param cell cell to be added to the region
-     */
-    public void addCell(T cell) {
-        regionCells.add(cell);
-    }
-
-    /**
-     * Removes the cell from the region
-     * @param cell cell to be remove from the region
-     */
-    public void removeCell(T cell) {
-        regionCells.remove(cell);
-    }
-
-    /**
-     * Returns the list of cells in the region
-     * @return list of cells in region
-     */
-    public List<T> getCells() {
-        return regionCells;
-    }
-
-    /**
-     * Returns the number of cells in the region
-     * @return number of cells in the region
-     */
-    public int getSize(){
-        return regionCells.size();
-    }
-
-    /*
-    public void colorRegion(){}
-     */
-
-}
+package edu.rpi.legup.model.gameboard;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public abstract class GridRegion<T> {
+
+    protected List<T> regionCells;
+
+    /** Region Constructor */
+    public GridRegion() {
+        this.regionCells = new ArrayList<>();
+    }
+
+    /**
+     * Adds the cell to the region
+     *
+     * @param cell cell to be added to the region
+     */
+    public void addCell(T cell) {
+        regionCells.add(cell);
+    }
+
+    /**
+     * Removes the cell from the region
+     *
+     * @param cell cell to be remove from the region
+     */
+    public void removeCell(T cell) {
+        regionCells.remove(cell);
+    }
+
+    /**
+     * Returns the list of cells in the region
+     *
+     * @return list of cells in region
+     */
+    public List<T> getCells() {
+        return regionCells;
+    }
+
+    /**
+     * Returns the number of cells in the region
+     *
+     * @return number of cells in the region
+     */
+    public int getSize() {
+        return regionCells.size();
+    }
+
+    /*
+    public void colorRegion(){}
+     */
+
+}