Add upstream refs (#140)

* Create action.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update pr-checks.yml

* Update pr-checks.yml

* Update pr-checks.yml

* Update pr-checks.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update action.yml

* Update pr-checks.yml

* Update pr-checks.yml

* Update action.yml

* Update pr-checks.yml

* Update action.yml

* Update pr-checks.yml

* Create PULL_REQUEST_TEMPLATE.md

* Update pr-checks.yml

Author: irshadahmad21

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+## Description
+
+Fixes
+
+### Remote Refs
+
+<!--- REMOTE REFS START -->
+
+premium: main
+
+<!--- REMOTE REFS END -->

.github/workflows/pr-checks.yml

@@ -4,9 +4,6 @@ on:
   pull_request:
     types: [opened, synchronize]
 
-env:
-  PREMIUM_REPO_REF: main
-
 jobs:
   php-lint-test:
     name: "PHP: Lint, Test"
@@ -22,13 +19,17 @@ jobs:
         with:
           token: ${{ secrets.ACCESS_TOKEN_IR }}
 
+      - name: Remote refs
+        uses: ./actions/upstream-refs
+        id: remote-refs
+
       - name: Checkout premium projects repo
         uses: actions/checkout@v4
         with:
           path: premium
           token: ${{ secrets.ACCESS_TOKEN_IR }}
           repository: ${{ secrets.PREMIUM_PROJECTS_REPO }}
-          ref: ${{ env.PREMIUM_REPO_REF }}
+          ref: ${{ fromJSON(steps.remote-refs.outputs.result).premium || 'main' }}
 
       - name: Setup Environment
         uses: ./actions/setup
@@ -72,13 +73,17 @@ jobs:
         with:
           token: ${{ secrets.ACCESS_TOKEN_IR }}
 
+      - name: Remote refs
+        uses: ./actions/upstream-refs
+        id: remote-refs
+
       - name: Checkout premium projects repo
         uses: actions/checkout@v4
         with:
           path: premium
           token: ${{ secrets.ACCESS_TOKEN_IR }}
           repository: ${{ secrets.PREMIUM_PROJECTS_REPO }}
-          ref: ${{ env.PREMIUM_REPO_REF }}
+          ref: ${{ fromJSON(steps.remote-refs.outputs.result).premium || 'main' }}
 
       - name: Setup Environment
         uses: ./actions/setup

actions/upstream-refs/action.yml

@@ -0,0 +1,53 @@
+name: "Read the refs/branches to use for checking out upstream repos"
+description: "Reads and outputs the refs/branches from PR description to use for checking out upstream repos."
+author: "wpsocio"
+
+outputs:
+  result:
+    description: "Refs JSON"
+    value: ${{ steps.details.outputs.result }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Get details
+      uses: actions/github-script@v7
+      id: details
+      with:
+        script: |
+          const pr = await github.rest.pulls.get({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            pull_number: context.payload.pull_request.number,
+          });
+
+          /**
+          * The comment has to be in this format
+          *
+          * <!--- REMOTE REFS START -->
+          * some/project/path: add/some-feature
+          * some/other/project/path: fix/some-bug
+          * <!--- REMOTE REFS END -->
+          */
+          const refsCommentRegex =
+            /<!--- REMOTE REFS START -->(?<content>.+)<!--- REMOTE REFS END -->/is;
+
+          const result = (pr.data.body || '').match(refsCommentRegex);
+
+          if (!result?.groups?.content) {
+            return {};
+          }
+
+          const refs = result.groups.content
+            .trim()
+            .split(/[\n\r]+/)
+            .filter((line) => line.trim())
+            .reduce((list, line) => {
+              const [name, ref] = line.split(/:\s?/);
+
+              list[name.trim()] = ref.trim();
+
+              return list;
+            }, {});
+
+          return refs;