feat: branch output (#9)

* docs: wording scope

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* add `branch` output

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* add branch action output

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* output branch from step

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* default `GITHUB_REF_NAME`

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* clarify fallback

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* reorder branch outputs

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* add `github.ref`

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* add `github.ref_name` fallback

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

---------

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

Author: rdhar

.github/workflows/tests.yaml

@@ -4,10 +4,8 @@ name: Tests
 on:
   issue_comment:
   merge_group:
-  pull_request_review_comment:
-  pull_request_review:
-  pull_request_target:
   pull_request:
+  pull_request_target:
   push:
   workflow_dispatch:
 
@@ -35,8 +33,10 @@ jobs:
           sparse-checkout: action.yml
 
       - name: PR data
-        id: pr-data
+        id: pr
         uses: ./
 
       - name: Echo data
-        run: echo Number "${{ steps.pr-data.outputs.number }}" from "${{ github.event_name }} event."
+        run: |
+          echo Number "${{ steps.pr.outputs.number }}" from "${{ github.event_name }} event."
+          echo Branch "${{ steps.pr.outputs.branch }}" from "${{ github.event_name }} event."

README.md

@@ -30,14 +30,14 @@ jobs:
     runs-on: ubuntu-latest
 
     permissions:
-      contents: read      # Required to checkout repository.
       pull-requests: read # Required to get PR data.
 
     steps:
-      - uses: actions/checkout@v4
       - id: pr
         uses: op5dev/current-pr@v1
-      - run: echo "PR number is ${{ steps.pr.outputs.number }}"
+      - run: |
+          echo "PR number ${{ steps.pr.outputs.number }}"
+          echo "PR branch ${{ steps.pr.outputs.branch }}"
 ```
 
 </br>
@@ -46,20 +46,18 @@ jobs:
 
 ### Inputs
 
-| Required | Name    | Description                                                 |
-| -------- | ------- | ----------------------------------------------------------- |
-| No       | `token` | Specify a GitHub token.</br>Default: `${{ github.token }}`. |
+| Name    | Description                                                                |
+| ------- | -------------------------------------------------------------------------- |
+| `token` | Specify a GitHub token (not required).</br>Default: `${{ github.token }}`. |
 
 </br>
 
 ### Outputs
 
-| Name         | Description                       |
-| ------------ | --------------------------------- |
-| ~~`body`~~   | ~~The body of the current PR.~~   |
-| ~~`branch`~~ | ~~The branch of the current PR.~~ |
-| `number`     | The number of the current PR.     |
-| ~~`title`~~  | ~~The title of the current PR.~~  |
+| Name     | Description        |
+| -------- | ------------------ |
+| `branch` | Current PR branch. |
+| `number` | Current PR number. |
 
 </br>
 
@@ -86,7 +84,6 @@ View [all notable changes](https://github.com/op5dev/current-pr/releases "Releas
 
 ### To-Do
 
-- Output parameters like `body`, `branch`, and `title` will be added in upcoming releases.
 - Workflow event triggers like `workflow_dispatch`, and `workflow_run` (fork) will be added in upcoming releases.
 
 </br>

action.yml

@@ -25,24 +25,20 @@ runs:
           # Get the PR number by parsing the ref name.
           number=$(echo "${GITHUB_REF_NAME}" | sed -n 's/.*pr-\([0-9]*\)-.*/\1/p')
         else
-          # Get the PR number from the event payload or fallback on 0.
+          # Fallback on 0 if the PR number is not found.
           number=${{ github.event.number || github.event.issue.number || 0 }}
         fi
+        branch=${{ github.ref_name || github.head_ref || github.ref || '' }}
+        echo "branch=$branch" >> "$GITHUB_OUTPUT"
         echo "number=$number" >> "$GITHUB_OUTPUT"
 
 outputs:
-  # body:
-  #   description: "The body of the current PR."
-  #   value: ${{ steps.data.outputs.body }}
-  # branch:
-  #   description: "The branch of the current PR."
-  #   value: ${{ steps.data.outputs.branch }}
+  branch:
+    description: "Current PR branch."
+    value: ${{ steps.data.outputs.branch }}
   number:
-    description: "The number of the current PR."
+    description: "Current PR number."
     value: ${{ steps.data.outputs.number }}
-  # title:
-  #   description: "The title of the current PR."
-  #   value: ${{ steps.data.outputs.title }}
 
 inputs:
   token: