Merge pull request #36 from vaisakhkannan/Fix-#998-Allow-input-LSP4IJ…

…-PR-number

Fix OpenLiberty#998 allow input lsp4 ij pr number

.github/workflows/build.yaml

@@ -29,8 +29,13 @@ on:
         required: true
         type: boolean
         default: false
+      lsp4ijPrNumber:
+        description: 'Run build with an LSP4IJ PR. Make sure to enter the LSP4IJ PR number in the \"Reference/branch/PR for LSP4IJ checkout\" input box.'
+        required: true
+        type: boolean
+        default: false
       refLsp4ij:
-        description: 'Reference/branch for Lsp4ij checkout'
+        description: 'Reference/branch/PR for LSP4IJ checkout'
         type: string
         required: true
         default: main
@@ -45,7 +50,48 @@ on:
     branches: [ main ]
 
 jobs:
+  fetch_merge_commit_sha_from_lsp4ij_PR:
+    runs-on: ubuntu-latest
+    outputs:
+      pr_details: ${{ steps.extract.outputs.pr_details }}
+      checkout_name: ${{ steps.extract.outputs.checkout_name }}
+    env:
+      API_URL: https://api.github.com/repos/redhat-developer/lsp4ij/pulls
+      REF_LSP4IJ: ${{ inputs.refLsp4ij }}
+      LSP4IJ_BRANCH: ${{ inputs.lsp4ijBranch }}
+    name: Fetch Commit ${{ inputs.refLsp4ij || '' }}
+    steps:
+      - name: Extract Merge Commit SHA
+        shell: bash
+        id: extract
+        run: |
+          pr_details="${{ env.REF_LSP4IJ }}"
+          checkout_name="${{ env.LSP4IJ_BRANCH }}"
+
+          if [ "${{ inputs.lsp4ijPrNumber }}" == "true" ]; then
+            url="${{ env.API_URL }}/${{ env.REF_LSP4IJ }}"
+            pr_detail=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" "$url")
+            pr_details=$(jq -r '.merge_commit_sha' <<< "$pr_detail" | xargs)
+            echo "Merge commit SHA of PR ${{ env.REF_LSP4IJ }}: $pr_details"
+            checkout_name="${{ env.REF_LSP4IJ }}"
+            if [[ "$pr_details" == "null" ]]; then
+              echo "::warning file=::The merge commit SHA of the entered PR is null. Please try again later or use a different PR number."
+            fi
+          elif [ -z "$pr_details" ]; then
+            echo "No LSP4IJ checkout found. Using default case."
+          elif [ -z "$checkout_name" ]; then
+            echo "Merge Commit SHA/Branch Name/Tag : $pr_details"
+            checkout_name="${{ env.REF_LSP4IJ }}"
+          else
+            echo "Merge Commit SHA/Branch Name/Tag : $pr_details"
+          fi
+
+          # Set output for further steps
+          echo "pr_details=$pr_details" >> $GITHUB_OUTPUT
+          echo "checkout_name=$checkout_name" >> $GITHUB_OUTPUT
+
   build:
+    needs: fetch_merge_commit_sha_from_lsp4ij_PR
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -63,8 +109,8 @@ jobs:
             reportName: windows-test-report
     env:
       USE_LOCAL_PLUGIN: ${{ inputs.useLocalPlugin || false }}
-      REF_LSP4IJ: ${{ inputs.refLsp4ij }}
-      LSP4IJ_BRANCH: ${{ inputs.lsp4ijBranch || 'default' }}
+      REF_LSP4IJ: ${{ needs.fetch_merge_commit_sha_from_lsp4ij_PR.outputs.pr_details }}
+      LSP4IJ_BRANCH: ${{ needs.fetch_merge_commit_sha_from_lsp4ij_PR.outputs.checkout_name }}
       REF_LTI_TAG: ${{ inputs.refLTITag }}
     steps:
       - name: Configure pagefile
@@ -108,7 +154,7 @@ jobs:
         if: ${{ runner.os == 'Linux' && !failure() }}
         uses: actions/[email protected]
         with:
-          name: liberty-tools-intellij-LTI-${{ env.REF_LTI_TAG || 'default' }}-LSP4IJ-${{ env.LSP4IJ_BRANCH }}
+          name: liberty-tools-intellij-LTI-${{ env.REF_LTI_TAG || 'default' }}-LSP4IJ-${{ env.LSP4IJ_BRANCH || 'default' }}
           path: |
             ./**/*liberty-tools-intellij*.zip
             ./**/libs/*liberty-tools-intellij*.jar
@@ -122,6 +168,6 @@ jobs:
         if: ${{ failure() && steps.run_tests.conclusion == 'failure' }}
         uses: actions/[email protected]
         with:
-          name: ${{ matrix.reportName }}-LTI-${{ env.REF_LTI_TAG || 'default' }}-LSP4IJ-${{ env.LSP4IJ_BRANCH }}
+          name: ${{ matrix.reportName }}-LTI-${{ env.REF_LTI_TAG || 'default' }}-LSP4IJ-${{ env.LSP4IJ_BRANCH || 'default' }}
           path: |
             liberty-tools-intellij/build/reports/

docs/LSP4IJ-Continuous-Integration.md

@@ -218,6 +218,14 @@ For example, if you want to trigger the Build Workflow from the `main` branch of
 
 <img alt="Example" height="300" src="images/example-manually-trigger.png" width="300" style="display: block; margin: 0 auto;"/>
 
+If you want to check out LSP4IJ based on a PR number, you can check the box labeled `Run build with an LSP4IJ PR.` and specify the PR number in the provided text field labeled `Reference/branch/PR for LSP4IJ checkout`. Additionally, you can specify the tag or branch of the `liberty-tools-intellij` repository to be used. 
+
+> NOTE: Make sure to enable the checkbox labeled `Use lsp4ij locally` as well for this case.
+
+For example, if you want to trigger the Build Workflow from a branch of the LTI repository and build against LSP4IJ PR number `500` while using the `main` branch of LTI, you would configure it as follows:
+
+<img alt="Example" height="300" src="images/Allow-developer-to-input-PR-number.png" width="300" style="display: block; margin: 0 auto;"/>
+
 # How to specify LTI tags or branches in CI-CD builds
 
 The **LTI Tags/Branches** must be specified in two locations within the `cronJob.yaml` file.