├── .github
└── CODEOWNERS
├── .gitignore
├── .vscode
└── settings.json
├── CHANGELOG.md
├── README.md
├── app.yml
├── get-changed-packages.ts
├── index.test.js
├── index.ts
├── next-env.d.ts
├── package.json
├── pages
└── api
│ └── webhook.ts
├── test
└── fixtures
│ ├── pull_request.opened.json
│ ├── pull_request.synchronize.json
│ └── release_pull_request.opened.json
├── tsconfig.json
└── yarn.lock
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @emmatown
2 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | .next
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "typescript.tsdk": "node_modules/typescript/lib"
3 | }
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # @changesets/bot
2 |
3 | ## 1.2.0
4 |
5 | ### Minor Changes
6 |
7 | - Add a link to create a changeset from the comment
8 | - Optimise network calls
9 |
10 | ## 1.1.5
11 |
12 | ### Patch Changes
13 |
14 | - 6dbc7dc: Fix babel configs for building packages to produce working dists for node scripts.
15 |
16 | ## 1.1.4
17 |
18 | ### Patch Changes
19 |
20 | - 88dd1b5: Refactored bot to combine endpoints and added unit tests
21 |
22 | ## 1.1.3
23 |
24 | ### Patch Changes
25 |
26 | - 5e9ecdc: Fix spelling error
27 | - 2ca59c0: Change deployment environment to staging
28 |
29 | ## 1.1.2
30 |
31 | ### Patch Changes
32 |
33 | - a18dd18: Got feedback that our changeset messages could be a bit loud/scary. Here is some lighter, friendlier text
34 |
35 | ## 1.1.1
36 |
37 | - [patch] fa74183:
38 |
39 | - Link messages out to information on changesets
40 |
41 | - [patch] a1d1b56:
42 |
43 | - Display commit sha instead of commit message in bot comment
44 |
45 | ## 1.1.0
46 |
47 | - [patch] f7a6395:
48 |
49 | - Handle case where committer field in webhook event is null
50 |
51 | - [minor] 9bd107d:
52 |
53 | - Added new bot to detect changesets on PRs
54 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # changeset-bot
2 |
3 | > A GitHub App built with [Probot](https://github.com/probot/probot) to detect [changesets](https://github.com/atlassian/changesets) in PRs
4 |
5 | ## Install the bot at https://github.com/apps/changeset-bot
6 |
7 |
8 |
9 | This bot will comment on PRs saying that either a user might need to add a changeset(note that PRs changing things like documentation generally don't need a changeset)or say that the PR is good and already has a changeset.
10 |
11 | 
12 |
13 | 
14 |
15 |
16 | Sometimes, a contributor won't add a changeset to a PR but you might want to merge in the PR without having to wait on them to add it. To address this, this bot adds a link with the filename pre-filled to add a changeset so all you have to do is write the changeset and click commit.
17 |
18 | 
19 |
20 | 
21 |
22 | 
23 |
24 |
25 |
26 | When writing the changeset, it should look something like this with the packages that are being released in the YAML front matter with associated semver bump types and the summary of the changes in markdown.
27 |
28 | ```markdown
29 | ---
30 | '@changesets/cli': major
31 | '@changesets/read': minor
32 | ---
33 |
34 | A very helpful description of the changes
35 | ```
36 | ---
37 |
38 | The information below is for contributing to the bot.
39 |
40 |
41 | ## Setup
42 |
43 | ```sh
44 | yarn
45 | ```
46 |
47 | ## Behaviour
48 |
49 | The changeset bot will listen for pull requests being opened and pull requests that have been updated, upon which it will
50 | then scan through the files for a changeset that has been added. The bot will make a comment on the PR stating
51 | whether it found a changeset or not, as well as the message of the latest commit. If the PR is being updated
52 | then the bot will update the existing comment
53 |
--------------------------------------------------------------------------------
/app.yml:
--------------------------------------------------------------------------------
1 | # This is a GitHub App Manifest. These settings will be used by default when
2 | # initially configuring your GitHub App.
3 | #
4 | # NOTE: changing this file will not update your GitHub App settings.
5 | # You must visit github.com/settings/apps/your-app-name to edit them.
6 | #
7 | # Read more about configuring your GitHub App:
8 | # https://probot.github.io/docs/development/#configuring-a-github-app
9 | #
10 | # Read more about GitHub App Manifests:
11 | # https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/
12 |
13 | # The list of events the GitHub App subscribes to.
14 | # Uncomment the event names below to enable them.
15 | default_events:
16 | # - check_run
17 | # - check_suite
18 | # - commit_comment
19 | # - create
20 | # - delete
21 | # - deployment
22 | # - deployment_status
23 | # - fork
24 | # - gollum
25 | # - issue_comment
26 | - issues
27 | # - label
28 | # - milestone
29 | # - member
30 | # - membership
31 | # - org_block
32 | # - organization
33 | # - page_build
34 | # - project
35 | # - project_card
36 | # - project_column
37 | # - public
38 | - pull_request
39 | # - pull_request_review
40 | # - pull_request_review_comment
41 | # - push
42 | # - release
43 | # - repository
44 | # - repository_import
45 | # - status
46 | # - team
47 | # - team_add
48 | # - watch
49 |
50 | # The set of permissions needed by the GitHub App. The format of the object uses
51 | # the permission name for the key (for example, issues) and the access type for
52 | # the value (for example, write).
53 | # Valid values are `read`, `write`, and `none`
54 | default_permissions:
55 | # Repository creation, deletion, settings, teams, and collaborators.
56 | # https://developer.github.com/v3/apps/permissions/#permission-on-administration
57 | # administration: read
58 |
59 | # Checks on code.
60 | # https://developer.github.com/v3/apps/permissions/#permission-on-checks
61 | # checks: read
62 |
63 | # Repository contents, commits, branches, downloads, releases, and merges.
64 | # https://developer.github.com/v3/apps/permissions/#permission-on-contents
65 | # contents: read
66 |
67 | # Deployments and deployment statuses.
68 | # https://developer.github.com/v3/apps/permissions/#permission-on-deployments
69 | # deployments: read
70 |
71 | # Issues and related comments, assignees, labels, and milestones.
72 | # https://developer.github.com/v3/apps/permissions/#permission-on-issues
73 | issues: write
74 |
75 | # Search repositories, list collaborators, and access repository metadata.
76 | # https://developer.github.com/v3/apps/permissions/#metadata-permissions
77 | metadata: read
78 |
79 | # Retrieve Pages statuses, configuration, and builds, as well as create new builds.
80 | # https://developer.github.com/v3/apps/permissions/#permission-on-pages
81 | # pages: read
82 |
83 | # Pull requests and related comments, assignees, labels, milestones, and merges.
84 | # https://developer.github.com/v3/apps/permissions/#permission-on-pull-requests
85 | pull_requests: write
86 |
87 | # Manage the post-receive hooks for a repository.
88 | # https://developer.github.com/v3/apps/permissions/#permission-on-repository-hooks
89 | # repository_hooks: read
90 |
91 | # Manage repository projects, columns, and cards.
92 | # https://developer.github.com/v3/apps/permissions/#permission-on-repository-projects
93 | # repository_projects: read
94 |
95 | # Retrieve security vulnerability alerts.
96 | # https://developer.github.com/v4/object/repositoryvulnerabilityalert/
97 | # vulnerability_alerts: read
98 |
99 | # Commit statuses.
100 | # https://developer.github.com/v3/apps/permissions/#permission-on-statuses
101 | # statuses: read
102 |
103 | # Organization members and teams.
104 | # https://developer.github.com/v3/apps/permissions/#permission-on-members
105 | # members: read
106 |
107 | # View and manage users blocked by the organization.
108 | # https://developer.github.com/v3/apps/permissions/#permission-on-organization-user-blocking
109 | # organization_user_blocking: read
110 |
111 | # Manage organization projects, columns, and cards.
112 | # https://developer.github.com/v3/apps/permissions/#permission-on-organization-projects
113 | # organization_projects: read
114 |
115 | # Manage team discussions and related comments.
116 | # https://developer.github.com/v3/apps/permissions/#permission-on-team-discussions
117 | # team_discussions: read
118 |
119 | # Manage the post-receive hooks for an organization.
120 | # https://developer.github.com/v3/apps/permissions/#permission-on-organization-hooks
121 | # organization_hooks: read
122 |
123 | # Get notified of, and update, content references.
124 | # https://developer.github.com/v3/apps/permissions/
125 | # organization_administration: read
126 |
127 |
128 | # The name of the GitHub App. Defaults to the name specified in package.json
129 | # name: My Probot App
130 |
131 | # The homepage of your GitHub App.
132 | # url: https://example.com/
133 |
134 | # A description of the GitHub App.
135 | # description: A description of my awesome app
136 |
137 | # Set to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.
138 | # Default: true
139 | # public: false
140 |
--------------------------------------------------------------------------------
/get-changed-packages.ts:
--------------------------------------------------------------------------------
1 | import nodePath from "path";
2 | import micromatch from "micromatch";
3 | import { ProbotOctokit } from "probot";
4 | import fetch from "node-fetch";
5 | import { safeLoad } from "js-yaml";
6 | import { Packages, Tool } from "@manypkg/get-packages";
7 | import assembleReleasePlan from "@changesets/assemble-release-plan";
8 | import { parse as parseConfig } from "@changesets/config";
9 | import { PreState, NewChangeset } from "@changesets/types";
10 | import parseChangeset from "@changesets/parse";
11 |
12 | export let getChangedPackages = async ({
13 | owner,
14 | repo,
15 | ref,
16 | changedFiles: changedFilesPromise,
17 | octokit,
18 | installationToken,
19 | }: {
20 | owner: string;
21 | repo: string;
22 | ref: string;
23 | changedFiles: string[] | Promise;
24 | octokit: InstanceType;
25 | installationToken: string;
26 | }) => {
27 | let hasErrored = false;
28 | let encodedCredentials = Buffer.from(
29 | `x-access-token:${installationToken}`
30 | ).toString("base64");
31 |
32 | function fetchFile(path: string) {
33 | return fetch(
34 | `https://raw.githubusercontent.com/${owner}/${repo}/${ref}/${path}`,
35 | {
36 | headers: {
37 | Authorization: `Basic ${encodedCredentials}`,
38 | },
39 | }
40 | );
41 | }
42 |
43 | function fetchJsonFile(path: string) {
44 | return fetchFile(path)
45 | .then((x) => x.json())
46 | .catch((err) => {
47 | hasErrored = true;
48 | console.error(err);
49 | return {};
50 | });
51 | }
52 |
53 | function fetchTextFile(path: string) {
54 | return fetchFile(path)
55 | .then((x) => x.text())
56 | .catch((err) => {
57 | hasErrored = true;
58 | console.error(err);
59 | return "";
60 | });
61 | }
62 |
63 | async function getPackage(pkgPath: string) {
64 | let jsonContent = await fetchJsonFile(pkgPath + "/package.json");
65 | return {
66 | packageJson: jsonContent,
67 | dir: pkgPath,
68 | };
69 | }
70 |
71 | let rootPackageJsonContentsPromise = fetchJsonFile("package.json");
72 | let configPromise: Promise = fetchJsonFile(".changeset/config.json");
73 |
74 | let tree = await octokit.git.getTree({
75 | owner,
76 | repo,
77 | recursive: "1",
78 | tree_sha: ref,
79 | });
80 |
81 | let preStatePromise: Promise | undefined;
82 | let changesetPromises: Promise[] = [];
83 | let potentialWorkspaceDirectories: string[] = [];
84 | let isPnpm = false;
85 | let changedFiles = await changedFilesPromise;
86 |
87 | for (let item of tree.data.tree) {
88 | if (!item.path) continue;
89 | if (item.path.endsWith("/package.json")) {
90 | let dirPath = nodePath.dirname(item.path);
91 | potentialWorkspaceDirectories.push(dirPath);
92 | } else if (item.path === "pnpm-workspace.yaml") {
93 | isPnpm = true;
94 | } else if (item.path === ".changeset/pre.json") {
95 | preStatePromise = fetchJsonFile(".changeset/pre.json");
96 | } else if (
97 | item.path !== ".changeset/README.md" &&
98 | item.path.startsWith(".changeset") &&
99 | item.path.endsWith(".md") &&
100 | changedFiles.includes(item.path)
101 | ) {
102 | let res = /\.changeset\/([^\.]+)\.md/.exec(item.path);
103 | if (!res) {
104 | throw new Error("could not get name from changeset filename");
105 | }
106 | let id = res[1];
107 | changesetPromises.push(
108 | fetchTextFile(item.path).then((text) => {
109 | return { ...parseChangeset(text), id };
110 | })
111 | );
112 | }
113 | }
114 | let tool:
115 | | {
116 | tool: Tool;
117 | globs: string[];
118 | }
119 | | undefined;
120 |
121 | if (isPnpm) {
122 | tool = {
123 | tool: "pnpm",
124 | globs: safeLoad(await fetchTextFile("pnpm-workspace.yaml")).packages,
125 | };
126 | } else {
127 | let rootPackageJsonContent = await rootPackageJsonContentsPromise;
128 |
129 | if (rootPackageJsonContent.workspaces) {
130 | if (!Array.isArray(rootPackageJsonContent.workspaces)) {
131 | tool = {
132 | tool: "yarn",
133 | globs: rootPackageJsonContent.workspaces.packages,
134 | };
135 | } else {
136 | tool = {
137 | tool: "yarn",
138 | globs: rootPackageJsonContent.workspaces,
139 | };
140 | }
141 | } else if (
142 | rootPackageJsonContent.bolt &&
143 | rootPackageJsonContent.bolt.workspaces
144 | ) {
145 | tool = {
146 | tool: "bolt",
147 | globs: rootPackageJsonContent.bolt.workspaces,
148 | };
149 | }
150 | }
151 |
152 | let rootPackageJsonContent = await rootPackageJsonContentsPromise;
153 |
154 | let packages: Packages = {
155 | root: {
156 | dir: "/",
157 | packageJson: rootPackageJsonContent,
158 | },
159 | tool: tool ? tool.tool : "root",
160 | packages: [],
161 | };
162 |
163 | if (tool) {
164 | if (
165 | !Array.isArray(tool.globs) ||
166 | !tool.globs.every((x) => typeof x === "string")
167 | ) {
168 | throw new Error("globs are not valid: " + JSON.stringify(tool.globs));
169 | }
170 | let matches = micromatch(potentialWorkspaceDirectories, tool.globs);
171 |
172 | packages.packages = await Promise.all(
173 | matches.map((dir) => getPackage(dir))
174 | );
175 | } else {
176 | packages.packages.push(packages.root);
177 | }
178 | if (hasErrored) {
179 | throw new Error("an error occurred when fetching files");
180 | }
181 |
182 | const releasePlan = assembleReleasePlan(
183 | await Promise.all(changesetPromises),
184 | packages,
185 | await configPromise.then((rawConfig) => parseConfig(rawConfig, packages)),
186 | await preStatePromise
187 | );
188 |
189 | return {
190 | changedPackages: (packages.tool === "root"
191 | ? packages.packages
192 | : packages.packages.filter((pkg) =>
193 | changedFiles.some((changedFile) => changedFile.startsWith(`${pkg.dir}/`))
194 | )
195 | ).map((x) => x.packageJson.name),
196 | releasePlan,
197 | };
198 | };
199 |
--------------------------------------------------------------------------------
/index.test.js:
--------------------------------------------------------------------------------
1 | const nock = require("nock");
2 | const { Probot } = require("probot");
3 | const outdent = require("outdent");
4 |
5 | const changesetBot = require(".");
6 |
7 | const pullRequestOpen = require("./test/fixtures/pull_request.opened");
8 | const pullRequestSynchronize = require("./test/fixtures/pull_request.synchronize");
9 | const releasePullRequestOpen = require("./test/fixtures/release_pull_request.opened");
10 |
11 | nock.disableNetConnect();
12 |
13 | /*
14 | Oh god none of these tests work - we should really do something about having this tested
15 | */
16 | describe.skip("changeset-bot", () => {
17 | let probot;
18 |
19 | beforeEach(() => {
20 | probot = new Probot({});
21 | const app = probot.load(changesetBot);
22 |
23 | // just return a test token
24 | app.app = () => "test.ts";
25 | });
26 |
27 | it("should add a comment when there is no comment", async () => {
28 | nock("https://api.github.com")
29 | .get("/repos/pyu/testing-things/issues/1/comments")
30 | .reply(200, []);
31 |
32 | nock("https://api.github.com")
33 | .get("/repos/pyu/testing-things/pulls/1/files")
34 | .reply(200, [
35 | { filename: ".changeset/something/changes.md", status: "added" }
36 | ]);
37 |
38 | nock("https://api.github.com")
39 | .get("/repos/pyu/testing-things/pulls/1/commits")
40 | .reply(200, [{ sha: "ABCDE" }]);
41 |
42 | nock("https://api.github.com")
43 | .post("/repos/pyu/testing-things/issues/1/comments", body => {
44 | expect(body.comment_id).toBeNull();
45 | return true;
46 | })
47 | .reply(200);
48 |
49 | await probot.receive({
50 | name: "pull_request",
51 | payload: pullRequestOpen
52 | });
53 | });
54 |
55 | it("should update a comment when there is a comment", async () => {
56 | nock("https://api.github.com")
57 | .get("/repos/pyu/testing-things/issues/1/comments")
58 | .reply(200, [
59 | {
60 | id: 7,
61 | user: {
62 | login: "changeset-bot[bot]"
63 | }
64 | }
65 | ]);
66 |
67 | nock("https://api.github.com")
68 | .get("/repos/pyu/testing-things/pulls/1/files")
69 | .reply(200, [
70 | { filename: ".changeset/something/changes.md", status: "added" }
71 | ]);
72 |
73 | nock("https://api.github.com")
74 | .get("/repos/pyu/testing-things/pulls/1/commits")
75 | .reply(200, [{ sha: "ABCDE" }]);
76 |
77 | nock("https://api.github.com")
78 | .patch("/repos/pyu/testing-things/issues/comments/7", body => {
79 | expect(body.number).toBe(1);
80 | return true;
81 | })
82 | .reply(200);
83 |
84 | await probot.receive({
85 | name: "pull_request",
86 | payload: pullRequestSynchronize
87 | });
88 | });
89 |
90 | it("should show correct message if there is a changeset", async () => {
91 | nock("https://api.github.com")
92 | .get("/repos/pyu/testing-things/issues/1/comments")
93 | .reply(200, []);
94 |
95 | nock("https://api.github.com")
96 | .get("/repos/pyu/testing-things/pulls/1/files")
97 | .reply(200, [
98 | { filename: ".changeset/something/changes.md", status: "added" }
99 | ]);
100 |
101 | nock("https://api.github.com")
102 | .get("/repos/pyu/testing-things/pulls/1/commits")
103 | .reply(200, [{ sha: "ABCDE" }]);
104 |
105 | nock("https://api.github.com")
106 | .post("/repos/pyu/testing-things/issues/1/comments", ({ body }) => {
107 | expect(body).toEqual(outdent`
108 | ### 🦋 Changeset is good to go
109 |
110 | Latest commit: ABCDE
111 |
112 | **We got this.**
113 |
114 | Not sure what this means? [Click here to learn what changesets are](https://github.com/Noviny/changesets/blob/master/docs/adding-a-changeset.md).`);
115 | return true;
116 | })
117 | .reply(200);
118 |
119 | await probot.receive({
120 | name: "pull_request",
121 | payload: pullRequestOpen
122 | });
123 | });
124 |
125 | it("should show correct message if there is no changeset", async () => {
126 | nock("https://api.github.com")
127 | .get("/repos/pyu/testing-things/issues/1/comments")
128 | .reply(200, []);
129 |
130 | nock("https://api.github.com")
131 | .get("/repos/pyu/testing-things/pulls/1/files")
132 | .reply(200, [{ filename: "index.js", status: "added" }]);
133 |
134 | nock("https://api.github.com")
135 | .get("/repos/pyu/testing-things/pulls/1/commits")
136 | .reply(200, [{ sha: "ABCDE" }]);
137 |
138 | nock("https://api.github.com")
139 | .post("/repos/pyu/testing-things/issues/1/comments", ({ body }) => {
140 | expect(body).toEqual(outdent`
141 | ### 💥 No Changeset
142 |
143 | Latest commit: ABCDE
144 |
145 | Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂
146 |
147 | **If these changes should be published to npm, you need to add a changeset.**
148 |
149 | [Click here to learn what changesets are, and how to add one](https://github.com/Noviny/changesets/blob/master/docs/adding-a-changeset.md).`);
150 | return true;
151 | })
152 | .reply(200);
153 |
154 | await probot.receive({
155 | name: "pull_request",
156 | payload: pullRequestOpen
157 | });
158 | });
159 |
160 | it("shouldn't add a comment to a release pull request", async () => {
161 | nock("https://api.github.com").reply(() => {
162 | // shouldn't reach this, but if it does - let it fail
163 | expect(true).toBe(false);
164 | });
165 |
166 | await probot.receive({
167 | name: "pull_request",
168 | payload: releasePullRequestOpen
169 | });
170 | });
171 | });
172 |
--------------------------------------------------------------------------------
/index.ts:
--------------------------------------------------------------------------------
1 | // @ts-ignore
2 | import humanId from "human-id";
3 | import { Probot, Context } from "probot";
4 | import { EmitterWebhookEvent } from "@octokit/webhooks";
5 | import { getChangedPackages } from "./get-changed-packages";
6 | import {
7 | ReleasePlan,
8 | ComprehensiveRelease,
9 | VersionType,
10 | } from "@changesets/types";
11 | import markdownTable from "markdown-table";
12 | import { captureException } from "@sentry/node";
13 | import { ValidationError } from "@changesets/errors";
14 |
15 | const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
16 | if (!releasePlan) return "";
17 |
18 | const publishableReleases = releasePlan.releases.filter(
19 | (x): x is ComprehensiveRelease & { type: Exclude } =>
20 | x.type !== "none"
21 | );
22 |
23 | let table = markdownTable([
24 | ["Name", "Type"],
25 | ...publishableReleases.map((x) => {
26 | return [
27 | x.name,
28 | {
29 | major: "Major",
30 | minor: "Minor",
31 | patch: "Patch",
32 | }[x.type],
33 | ];
34 | }),
35 | ]);
36 |
37 | return `This PR includes ${
38 | releasePlan.changesets.length
39 | ? `changesets to release ${
40 | publishableReleases.length === 1
41 | ? "1 package"
42 | : `${publishableReleases.length} packages`
43 | }`
44 | : "no changesets"
45 | }
46 |
47 | ${
48 | publishableReleases.length
49 | ? table
50 | : "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
51 | }
52 |
53 | 💥 An error occurred when fetching the changed packages and changesets in this PR
\n\n\`\`\`\n${err.message}\n\`\`\`\n\n