Merge pull request #39 from FranzDiebold/feat/add-pr-env-vars

Add pull request infos to environment variables.
FranzDiebold · May 3, 2021 · b9b3a88 · b9b3a88
2 parents 3bfb88d + 8551cab
commit b9b3a88
Show file tree

Hide file tree

Showing 6 changed files with 6,048 additions and 59 deletions.
diff --git a/.github/workflows/demo.yml b/.github/workflows/demo.yml
@@ -28,6 +28,8 @@ jobs:
           echo "CI_BASE_REF=$CI_BASE_REF"
           echo "CI_SHA_SHORT=$CI_SHA_SHORT"
           echo "CI_SHA=$CI_SHA"
+          echo "CI_PR_TITLE=$CI_PR_TITLE"
+          echo "CI_PR_DESCRIPTION=$CI_PR_DESCRIPTION"
           echo "CI_ACTOR=$CI_ACTOR"
           echo "CI_EVENT_NAME=$CI_EVENT_NAME"
           echo "CI_RUN_ID=$CI_RUN_ID"
@@ -73,6 +75,8 @@ jobs:
           echo "CI_BASE_REF=$Env:CI_BASE_REF"
           echo "CI_SHA_SHORT=$Env:CI_SHA_SHORT"
           echo "CI_SHA=$Env:CI_SHA"
+          echo "CI_PR_TITLE=$Env:CI_PR_TITLE"
+          echo "CI_PR_DESCRIPTION=$Env:CI_PR_DESCRIPTION"
           echo "CI_ACTOR=$Env:CI_ACTOR"
           echo "CI_EVENT_NAME=$Env:CI_EVENT_NAME"
           echo "CI_RUN_ID=$Env:CI_RUN_ID"
@@ -118,6 +122,8 @@ jobs:
           echo "CI_BASE_REF=$CI_BASE_REF"
           echo "CI_SHA_SHORT=$CI_SHA_SHORT"
           echo "CI_SHA=$CI_SHA"
+          echo "CI_PR_TITLE=$CI_PR_TITLE"
+          echo "CI_PR_DESCRIPTION=$CI_PR_DESCRIPTION"
           echo "CI_ACTOR=$CI_ACTOR"
           echo "CI_EVENT_NAME=$CI_EVENT_NAME"
           echo "CI_RUN_ID=$CI_RUN_ID"

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![GitHub Action: View on Marketplace](https://img.shields.io/badge/GitHub%20Action-View_on_Marketplace-28a745?logo=github)](https://github.com/marketplace/actions/github-environment-variables-action)
 [![Demo: available](https://img.shields.io/badge/Demo-available-orange)](.github/workflows/demo.yml)
-[![Version: v2.2.0](https://img.shields.io/badge/Version-v2.2.0-brightgreen)](https://github.com/FranzDiebold/github-env-vars-action/releases/tag/v2.2.0)
+[![Version: v2.3.0](https://img.shields.io/badge/Version-v2.3.0-brightgreen)](https://github.com/FranzDiebold/github-env-vars-action/releases/tag/v2.3.0)
 [![Lint and Test](https://github.com/FranzDiebold/github-env-vars-action/workflows/Lint%20and%20Test/badge.svg)](https://github.com/FranzDiebold/github-env-vars-action/actions?query=workflow%3A%22Lint+and+Test%22)
 [![license: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](./LICENSE)
 
@@ -30,6 +30,8 @@ A [GitHub Action](https://github.com/features/actions) to expose useful environm
 | `CI_BASE_REF`              | Only set for forked repositories / pull request. The branch of the base repository / the base branch name. Copy of `GITHUB_BASE_REF` - for reasons of completeness. | `main`                                |
 | `CI_SHA_SHORT`             | The shortened commit SHA (8 characters) that triggered the workflow.                                                                                           | `ffac537e`                                 |
 | `CI_SHA`                   | The commit SHA that triggered the workflow. Copy of `GITHUB_SHA` - for reasons of completeness.                                                                | `ffac537e6cbbf934b08745a378932722df287a53` |
+| `CI_PR_TITLE`              | The title of the pull request. Only set for pull requests.                                                                                                     | `Add feature xyz.`                         |
+| `CI_PR_DESCRIPTION`        | The description of the pull request. Only set for pull requests.                                                                                               | `The feature xyz is the [...]`             |
 | `CI_ACTOR`                 | The name of the person or app that initiated the workflow. Copy of `GITHUB_ACTOR` - for reasons of completeness.                                               | `octocat`                                  |
 | `CI_EVENT_NAME`            | The name of the webhook event that triggered the workflow. Copy of `GITHUB_EVENT_NAME` - for reasons of completeness.                                          | `push` or `pull_request`                   |
 | `CI_RUN_ID`                | A unique number for each run within a repository. This number does not change if you re-run the workflow run. Copy of `GITHUB_RUN_ID` - for reasons of completeness. | `397746731`                          |