README.yaml

# Name of this project
name: Get PR

# Tags of this project
tags:
  - github-action

# License of this project
license: "GPL-3.0"

# Canonical GitHub repo
github_repo: cloudposse-github-actions/get-pr

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse-github-actions/get-pr.svg"
    url: "https://github.com/cloudposse-github-actions/get-pr/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related: []

# Short description of this project
description: |
  Get the PR info associated with the commit.

author: hello@cloudposse.com

introduction: |-
  Fork of [8BitJonny/gh-get-current-pr](https://github.com/8BitJonny/gh-get-current-pr) adopted to Cloud Posse's GitHub Actions standards. 

references: []

# How to use this project
usage: |-
  This action will retrieve the PR metadata by `id` (PR number) or commit `sha`.
  The `id` takes precedence over `sha`, if both are passed.
  
  ### By ID
  
  ```yaml
    on:
      pull_request:
        branches:
          - main
        types: [opened, synchronize, reopened]

    jobs:
      pr:
        name: PR Info
        runs-on: ubuntu-latest
        steps:
          - uses: cloudposse-github-actions/get-pr@main
            id: pr
            with:
              id: ${{ github.event.number }}
        outputs:
          base: ${{ fromJSON(steps.pr.outputs.pr).base.sha }}
          head: ${{ fromJSON(steps.pr.outputs.pr).head.sha }}
          found: ${{ steps.pr.outputs.found }}
          json: ${{ steps.pr.outputs.json }}
          number: ${{ steps.pr.outputs.number }}
          title: ${{ steps.pr.outputs.title }}
          body: ${{ steps.pr.outputs.body }}
          url: ${{ steps.pr.outputs.url }}
          created_at: ${{ steps.pr.outputs.created_at }}
          merged_at: ${{ steps.pr.outputs.merged_at }}
          closed_at: ${{ steps.pr.outputs.closed_at }}
          labels: ${{ steps.pr.outputs.labels }}
  ```

  ### By SHA
  
  ```yaml
    on:
      push:
        branches:
          - main

    jobs:
      pr:
        name: PR Info
        runs-on: ubuntu-latest
        steps:
          - uses: cloudposse-github-actions/get-pr@main
            id: pr
        outputs:
          base: ${{ fromJSON(steps.pr.outputs.pr).base.sha }}
          head: ${{ fromJSON(steps.pr.outputs.pr).head.sha }}
          found: ${{ steps.pr.outputs.found }}
          json: ${{ steps.pr.outputs.json }}
          number: ${{ steps.pr.outputs.number }}
          title: ${{ steps.pr.outputs.title }}
          body: ${{ steps.pr.outputs.body }}
          url: ${{ steps.pr.outputs.url }}
          created_at: ${{ steps.pr.outputs.created_at }}
          merged_at: ${{ steps.pr.outputs.merged_at }}
          closed_at: ${{ steps.pr.outputs.closed_at }}
          labels: ${{ steps.pr.outputs.labels }}
  ```

include:
  - "docs/github-action.md"

# Contributors to this project
contributors:
  - name: "Timon Christiansen"
    github: "8BitJonny"
  - name: "Igor Rodionov"
    github: "goruha"