@culur/changesets-github-info

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

✨ Features

This library if a fork of @changesets/get-github-info. The main purpose of this library is to customize the returned results to suit the needs of use in @culur/changesets-changelog-github.

It uses @octokit/graphql and dataloader to query data. It also takes advantage of the dataloader's caching and batching features to optimize queries.

💿 Installation

Add @culur/changesets-github-info dependency to your project.

1# Using npm
2npm install @culur/changesets-github-info
3
4# Using pnpm
5pnpm install @culur/changesets-github-info
6
7# Using yarn
8yarn add @culur/changesets-github-info

📖 Usage

You need a GitHub Personal Access Token with read:user and repo:status permissions, and add it to a .env file.

GITHUB_TOKEN=token

Then you can use it in your script like this.

1import {
2  getCommitInfo,
3  getPullRequestInfo,
4} from '@culur/changesets-github-info';
5import { config } from 'dotenv';
6
7config();
8
9const commitInfo = await getCommitInfo({
10  repo: 'culur/culur',
11  commitHash: '65810fdd21ad34a2b06e42e977480bbfade20375',
12});
13
14const pullRequestInfo = await getPullRequestInfo({
15  repo: 'culur/culur',
16  pullRequestNumber: 3,
17});
18
19const commitInfo = {
20  user: {
21    name: 'github-actions',
22    link: '[@github-actions](https://github.com/apps/github-actions)',
23  },
24  commit: {
25    hash: '65810fdd21ad34a2b06e42e977480bbfade20375',
26    message: 'chore: version packages',
27    link: '[`65810fd`](https://github.com/culur/culur/commit/65810fdd21ad34a2b06e42e977480bbfade20375)',
28  },
29  pullRequest: {
30    number: 17,
31    title: 'chore: version packages',
32    link: '[#17](https://github.com/culur/culur/pull/17)',
33  },
34};
35
36const pullRequestInfo = {
37  user: {
38    name: 'github-actions',
39    link: '[@github-actions](https://github.com/apps/github-actions)',
40  },
41  commit: {
42    hash: '0a8933299dacec0fe2ad79e20c6e117d13e1ad81',
43    message: 'chore: version packages',
44    link: '[`0a89332`](https://github.com/culur/culur/commit/0a8933299dacec0fe2ad79e20c6e117d13e1ad81)',
45  },
46  pullRequest: {
47    number: 5,
48    title: 'chore: version packages',
49    link: '[#5](https://github.com/culur/culur/pull/5)',
50  },
51};

🗃️ Changelog

See CHANGELOG for more information on what has changed recently.

🔒 License

See LICENSE for license rights and limitations (MIT).