# gather-pull-request-metadata > Gather useful publicly available information about GitHub Pull Request and provide it in easy-to-digest JSON format. Latest version **1.10.0** (published 2026-05-20) · MIT license · 0 weekly downloads ## Install ```sh npm install gather-pull-request-metadata pnpm add gather-pull-request-metadata yarn add gather-pull-request-metadata bun add gather-pull-request-metadata ``` ## Health **Score 55/100 (C)** — status: active. Positive: esm support; no vulnerabilities; high maintenance score. Warnings: low downloads; no types. ## Facts | | | |---|---| | Version | 1.10.0 | | Published | 2026-05-20 | | First published | 2023-06-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 5 | | Unpacked size | 1.4 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | jamacku@redhat.com | | Maintainers | jamacku | | Keywords | github, github-actions, pull-request | ## Links - npm: https://www.npmjs.com/package/gather-pull-request-metadata - Repository: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata - Homepage: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata#readme - Issues: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/issues - npm.io page: https://npm.io/package/gather-pull-request-metadata ## Dependencies (5) - [zod](https://npm.io/package/zod.md) 4.4.3 - [@actions/core](https://npm.io/package/@actions/core.md) 3.0.1 - [@octokit/core](https://npm.io/package/@octokit/core.md) 7.0.6 - [@octokit/plugin-throttling](https://npm.io/package/@octokit/plugin-throttling.md) 11.0.3 - [@octokit/plugin-paginate-rest](https://npm.io/package/@octokit/plugin-paginate-rest.md) 14.0.0 ## Recent versions - 1.10.0 (latest) — 2026-05-20 - 1.9.1 — 2026-04-08 - 1.9.0 — 2026-01-26 - 1.7.1 — 2025-02-26 - 1.6.1 — 2024-01-19 - 1.5.0 — 2023-12-11 - 1.4.1 — 2023-09-22 - 1.3.1 — 2023-06-13 - 1.3.0 — 2023-06-13 ## README

Gather Pull Request Metadata

[![npm version][npm-status]][npm] [![GitHub Marketplace][market-status]][market] [![Lint Code Base][linter-status]][linter] [![Unit Tests][test-status]][test] [![CodeQL][codeql-status]][codeql] [![Check dist/][check-dist-status]][check-dist] [![codecov][codecov-status]][codecov] [npm]: https://www.npmjs.com/package/gather-pull-request-metadata [npm-status]: https://badgen.net/npm/v/gather-pull-request-metadata [market]: https://github.com/marketplace/actions/gather-pull-request-metadata [market-status]: https://img.shields.io/badge/Marketplace-Typescript%20Action-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII= [linter]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/lint.yml [linter-status]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/lint.yml/badge.svg [test]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/unit-tests.yml [test-status]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/unit-tests.yml/badge.svg [codeql]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/codeql-analysis.yml [codeql-status]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/codeql-analysis.yml/badge.svg [check-dist]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/check-dist.yml [check-dist-status]: https://github.com/redhat-plumbers-in-action/gather-pull-request-metadata/actions/workflows/check-dist.yml/badge.svg [codecov]: https://codecov.io/gh/redhat-plumbers-in-action/gather-pull-request-metadata [codecov-status]: https://codecov.io/gh/redhat-plumbers-in-action/gather-pull-request-metadata/branch/main/graph/badge.svg ## Usage ```yml name: Gather Pull Request Metadata on: pull_request: types: [ opened, reopened, synchronize ] permissions: contents: read jobs: gather-metadata: runs-on: ubuntu-latest permissions: # for ability to read PR comments issues: read pull-requests: read # only required for workflows in private repositories actions: read contents: read steps: - name: Repository checkout uses: actions/checkout@v6 - id: Metadata name: Gather Pull Request Metadata uses: redhat-plumbers-in-action/gather-pull-request-metadata@v1 - name: Upload artifact with gathered metadata uses: actions/upload-artifact@v7 with: name: Pull Request Metadata path: ${{ steps.Metadata.outputs.metadata-file }} ``` ## Configuration options Action currently accepts the following options: ```yml # ... - uses: redhat-plumbers-in-action/gather-pull-request-metadata@v1 with: pr-number: metadata-file-name: token: # ... ``` ### pr-number Number of Pull Request to gather metadata from. * default value: `${{ github.event.number }}` * requirements: `required` ### metadata-file-name Name of file where Pull Request metadata will be saved. * default value: `pr-metadata.json` * requirements: `optional` ### token Token used to access GitHub API. Read permissions are sufficient. * default value: `${{ github.token }}` * requirements: `required` * recommended value: `secrets.GITHUB_TOKEN` ## Outputs GitHub Action exposes following [outputs](https://docs.github.com/en/actions/using-jobs/defining-outputs-for-jobs). ### metadata ```json { "number": 123, "title": "[WIP] feat: add new feature", "draft": true, "base": "main", "ref": "dbb9ff194039a1e1567cb48e7261ee1a94d1b9f0", "url": "https://github.com/org/repo/pull/123", "labels": [ { "id": 123456789, "name": "my-label", "description": "Description of my-label label." } ], "milestone": { "title": "next-release" }, "commits": [ { "sha": "dbb9ff194039a1e1567cb48e7261ee1a94d1b9f0", "url": "https://github.com/org/repo/commit/dbb9ff194039a1e1567cb48e7261ee1a94d1b9f0", "message": { "title": "test: add tests for commit functionality", "body": "test: add tests for commit functionality\n\n(cherry picked from commit f921f712da87c6a770de94138595a83c13d778b5)\n\nThis reverts commit 1234567890123456789012345678901234567890.", "cherryPick": [ { "sha": "f921f712da87c6a770de94138595a83c13d778b5", } ], "revert": [ { "sha": "1234567890123456789012345678901234567890", } ] } } ], "metadata": [ { "id": { "key": "value" } } ], } ``` > [!NOTE] > > The `draft` field is `true` when the Pull Request is marked as a draft via GitHub or when its title contains `[WIP]` (case insensitive). > [!NOTE] > > The `metadata` object holds all [issue-metadata](https://github.com/redhat-plumbers-in-action/issue-metadata) objects from the Pull Request comments. Issue-metadata have the following format: ``. ### metadata-file Relative path to JSON file containing Pull Request metadata object. --- _Source: https://npm.io/package/gather-pull-request-metadata · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._