npmpackage.info

@changesets/get-github-info

🦋 A way to manage your versioning and changelogs with a focus on monorepos

0.6.0

9,434

MIT

TypeScript

46.97 kB

21,428,066 5.1

Installations

npm install @changesets/get-github-info

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Node Version

16.20.2

NPM Version

8.19.4 Score

85.7

Supply Chain

93.1

Quality

80.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

120

Total

755

Closed

110

Merged

525

Issues

Open

354

Total

672

Closed

318

Releases

422

@changesets/cli@2.27.12

Updated on Jan 24, 2025

@changesets/apply-release-plan@7.0.8

Updated on Jan 24, 2025

@changesets/get-release-plan@4.0.6

Updated on Dec 18, 2024

@changesets/cli@2.27.11

Updated on Dec 18, 2024

@changesets/config@3.0.5

Updated on Dec 18, 2024

@changesets/apply-release-plan@7.0.7

Updated on Dec 18, 2024

View All 422 releases

Contributors

147

View All 147 Contributors

Languages

TypeScript

JavaScript

TypeScript (99.85%)

JavaScript (0.15%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

changesets

Download Statistics

Total Downloads

21,428,066

Last Day

57,336

Last Week

298,763

Last Month

1,295,789

Last Year

11,777,530

GitHub Statistics

MIT License

9,434 Stars

606 Commits

597 Forks

35 Watchers

47 Branches

147 Contributors

Updated on Feb 13, 2025

Maintainers

Package Meta Information

Latest Version

0.6.0

Package Id

@changesets/get-github-info@0.6.0

Unpacked Size

46.97 kB

Size

9.04 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Nov 28, 2023

Total Downloads

Cumulative downloads

Total Downloads

21,428,066

Last Day

3.4%

57,336

Compared to previous day

Last Week

-0.9%

298,763

Compared to previous week

Last Month

54.5%

1,295,789

Compared to previous month

Last Year

107.1%

11,777,530

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

dataloader node-fetch

Dev Dependencies

nock prettier

@changesets/get-github-info

Get the GitHub username and PR number from a commit. Intended for use with changesets.

Getting Started

Note: This assumes you already have changesets setup.

To use @changesets/get-github-info, you'll need to install it and you'll probably also want dotenv to provide a GitHub personal access token via a .env file.

1yarn add --dev @changesets/get-github-info dotenv

1npm install --save-dev @changesets/get-github-info dotenv

Then you can use it in your .changeset/config.js like this.

1require("dotenv").config();
2const { getInfo } = require("@changesets/get-github-info");
3
4// ...
5
6const getReleaseLine = async (changeset, type) => {
7  const [firstLine, ...futureLines] = changeset.summary
8    .split("\n")
9    .map((l) => l.trimRight());
10  // getInfo exposes the GH username and PR number if you want them directly
11  // but it also exposes a set of links for the commit, PR and GH username
12  let { user, pull, links } = await getInfo({
13    // replace this with your own repo
14    repo: "Noviny/changesets",
15    commit: changeset.commit,
16  });
17  let returnVal = `- ${links.commit}${
18    links.pull === null ? "" : ` ${links.pull}`
19  }${links.user === null ? "" : ` Thanks ${links.user}!`}: ${firstLine}`;
20  if (futureLines.length > 0) {
21    returnVal += `\n${futureLines.map((l) => `  ${l}`).join("\n")}`;
22  }
23  return returnVal;
24};
25
26// ...

You'll need to get a GitHub personal access token with read:user and repo:status permissions, and add it to a .env file.

1GITHUB_TOKEN=token_here

You can now bump your packages and changelogs with changeset version and it'll have the GitHub info. 🎉

API

1type Info = {
2  user: string | null;
3  pull: number | null;
4  links: {
5    commit: string;
6    pull: string | null;
7    user: string | null;
8  };
9};
10
11type Options = {
12  commit: string;
13  repo: string;
14};
15
16export function getInfo(options: Options): Info {
17  // magic...
18}

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.1

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @changesets/get-github-info

@culur/changesets-github-info

1.1.3

Get the GitHub username and PR number from a commit. Intended for use with changesets.

@motss-changesets/get-github-info

0.5.5

Get the GitHub username and PR number from a commit. Intended for use with changesets.

tuanddd-get-github-info

0.4.4

Get the GitHub username and PR number from a commit. Intended for use with changesets.