diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7847cfe..92c7d3d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -30,11 +30,25 @@ jobs:
- name: Run test
run: yarn test
+ lint:
+ name: Lint
+ runs-on: ubuntu-latest
+ timeout-minutes: 20
+ steps:
+ - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1
+ with:
+ persist-credentials: false
+
+ - uses: ./.github/actions/ci-setup
+
+ - name: Run format:check
+ run: yarn format:check
+
ci-ok:
name: CI OK
runs-on: ubuntu-latest
if: always()
- needs: [test]
+ needs: [test, lint]
steps:
- name: Exit with error if some jobs are not successful
run: exit 1
diff --git a/.oxfmtrc.json b/.oxfmtrc.json
new file mode 100644
index 0000000..b61a81f
--- /dev/null
+++ b/.oxfmtrc.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "./node_modules/oxfmt/configuration_schema.json",
+ "ignorePatterns": ["CHANGELOG.md"],
+ "sortImports": {
+ "groups": [
+ "builtin",
+ "external",
+ ["internal", "subpath"],
+ "parent",
+ "sibling",
+ "index",
+ "side_effect",
+ "unknown"
+ ],
+ "newlinesBetween": true
+ }
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 55712c1..25fa621 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,3 +1,3 @@
{
- "typescript.tsdk": "node_modules/typescript/lib"
-}
\ No newline at end of file
+ "typescript.tsdk": "node_modules/typescript/lib"
+}
diff --git a/README.md b/README.md
index 03fb451..6a7caac 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,12 @@
## Install the bot at https://github.com/apps/changeset-bot
-
-
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.
-
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.
@@ -27,17 +24,17 @@ When writing the changeset, it should look something like this with the packages
```markdown
---
-'@changesets/cli': major
-'@changesets/read': minor
+"@changesets/cli": major
+"@changesets/read": minor
---
A very helpful description of the changes
```
+
---
The information below is for contributing to the bot.
-
## Setup
```sh
diff --git a/app.yml b/app.yml
index e4b2b54..0a1bed2 100644
--- a/app.yml
+++ b/app.yml
@@ -13,39 +13,39 @@
# The list of events the GitHub App subscribes to.
# Uncomment the event names below to enable them.
default_events:
-# - check_run
-# - check_suite
-# - commit_comment
-# - create
-# - delete
-# - deployment
-# - deployment_status
-# - fork
-# - gollum
-# - issue_comment
-- issues
-# - label
-# - milestone
-# - member
-# - membership
-# - org_block
-# - organization
-# - page_build
-# - project
-# - project_card
-# - project_column
-# - public
-- pull_request
-# - pull_request_review
-# - pull_request_review_comment
-# - push
-# - release
-# - repository
-# - repository_import
-# - status
-# - team
-# - team_add
-# - watch
+ # - check_run
+ # - check_suite
+ # - commit_comment
+ # - create
+ # - delete
+ # - deployment
+ # - deployment_status
+ # - fork
+ # - gollum
+ # - issue_comment
+ - issues
+ # - label
+ # - milestone
+ # - member
+ # - membership
+ # - org_block
+ # - organization
+ # - page_build
+ # - project
+ # - project_card
+ # - project_column
+ # - public
+ - pull_request
+ # - pull_request_review
+ # - pull_request_review_comment
+ # - push
+ # - release
+ # - repository
+ # - repository_import
+ # - status
+ # - team
+ # - team_add
+ # - watch
# The set of permissions needed by the GitHub App. The format of the object uses
# the permission name for the key (for example, issues) and the access type for
@@ -82,7 +82,7 @@ default_permissions:
# Pull requests and related comments, assignees, labels, milestones, and merges.
# https://developer.github.com/v3/apps/permissions/#permission-on-pull-requests
- pull_requests: write
+ pull_requests: write
# Manage the post-receive hooks for a repository.
# https://developer.github.com/v3/apps/permissions/#permission-on-repository-hooks
@@ -124,7 +124,6 @@ default_permissions:
# https://developer.github.com/v3/apps/permissions/
# organization_administration: read
-
# The name of the GitHub App. Defaults to the name specified in package.json
# name: My Probot App
diff --git a/get-changed-packages.ts b/get-changed-packages.ts
index 9a49325..2443efb 100644
--- a/get-changed-packages.ts
+++ b/get-changed-packages.ts
@@ -1,13 +1,14 @@
import nodePath from "path";
-import micromatch from "micromatch";
-import { ProbotOctokit } from "probot";
-import fetch from "node-fetch";
-import { safeLoad } from "js-yaml";
-import { Packages, Tool } from "@manypkg/get-packages";
+
import assembleReleasePlan from "@changesets/assemble-release-plan";
import { parse as parseConfig } from "@changesets/config";
-import { PreState, NewChangeset } from "@changesets/types";
import parseChangeset from "@changesets/parse";
+import { PreState, NewChangeset } from "@changesets/types";
+import { Packages, Tool } from "@manypkg/get-packages";
+import { safeLoad } from "js-yaml";
+import micromatch from "micromatch";
+import fetch from "node-fetch";
+import { ProbotOctokit } from "probot";
export let getChangedPackages = async ({
owner,
@@ -25,19 +26,14 @@ export let getChangedPackages = async ({
installationToken: string;
}) => {
let hasErrored = false;
- let encodedCredentials = Buffer.from(
- `x-access-token:${installationToken}`
- ).toString("base64");
+ let encodedCredentials = Buffer.from(`x-access-token:${installationToken}`).toString("base64");
function fetchFile(path: string) {
- return fetch(
- `https://raw.githubusercontent.com/${owner}/${repo}/${ref}/${path}`,
- {
- headers: {
- Authorization: `Basic ${encodedCredentials}`,
- },
- }
- );
+ return fetch(`https://raw.githubusercontent.com/${owner}/${repo}/${ref}/${path}`, {
+ headers: {
+ Authorization: `Basic ${encodedCredentials}`,
+ },
+ });
}
function fetchJsonFile(path: string) {
@@ -107,7 +103,7 @@ export let getChangedPackages = async ({
changesetPromises.push(
fetchTextFile(item.path).then((text) => {
return { ...parseChangeset(text), id };
- })
+ }),
);
}
}
@@ -138,10 +134,7 @@ export let getChangedPackages = async ({
globs: rootPackageJsonContent.workspaces,
};
}
- } else if (
- rootPackageJsonContent.bolt &&
- rootPackageJsonContent.bolt.workspaces
- ) {
+ } else if (rootPackageJsonContent.bolt && rootPackageJsonContent.bolt.workspaces) {
tool = {
tool: "bolt",
globs: rootPackageJsonContent.bolt.workspaces,
@@ -161,17 +154,12 @@ export let getChangedPackages = async ({
};
if (tool) {
- if (
- !Array.isArray(tool.globs) ||
- !tool.globs.every((x) => typeof x === "string")
- ) {
+ if (!Array.isArray(tool.globs) || !tool.globs.every((x) => typeof x === "string")) {
throw new Error("globs are not valid: " + JSON.stringify(tool.globs));
}
let matches = micromatch(potentialWorkspaceDirectories, tool.globs);
- packages.packages = await Promise.all(
- matches.map((dir) => getPackage(dir))
- );
+ packages.packages = await Promise.all(matches.map((dir) => getPackage(dir)));
} else {
packages.packages.push(packages.root);
}
@@ -183,14 +171,14 @@ export let getChangedPackages = async ({
await Promise.all(changesetPromises),
packages,
await configPromise.then((rawConfig) => parseConfig(rawConfig, packages)),
- await preStatePromise
+ await preStatePromise,
);
return {
changedPackages: (packages.tool === "root"
? packages.packages
: packages.packages.filter((pkg) =>
- changedFiles.some((changedFile) => changedFile.startsWith(`${pkg.dir}/`))
+ changedFiles.some((changedFile) => changedFile.startsWith(`${pkg.dir}/`)),
)
).map((x) => x.packageJson.name),
releasePlan,
diff --git a/index.ts b/index.ts
index 3096934..24ce0cf 100644
--- a/index.ts
+++ b/index.ts
@@ -1,23 +1,19 @@
+import { ValidationError } from "@changesets/errors";
+import { ReleasePlan, ComprehensiveRelease, VersionType } from "@changesets/types";
+import { EmitterWebhookEvent } from "@octokit/webhooks";
+import { captureException } from "@sentry/node";
// @ts-ignore
import humanId from "human-id";
+import markdownTable from "markdown-table";
import { Probot, Context } from "probot";
-import { EmitterWebhookEvent } from "@octokit/webhooks";
+
import { getChangedPackages } from "./get-changed-packages";
-import {
- ReleasePlan,
- ComprehensiveRelease,
- VersionType,
-} from "@changesets/types";
-import markdownTable from "markdown-table";
-import { captureException } from "@sentry/node";
-import { ValidationError } from "@changesets/errors";
const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
if (!releasePlan) return "";
const publishableReleases = releasePlan.releases.filter(
- (x): x is ComprehensiveRelease & { type: Exclude } =>
- x.type !== "none"
+ (x): x is ComprehensiveRelease & { type: Exclude } => x.type !== "none",
);
let table = markdownTable([
@@ -37,9 +33,7 @@ const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
return `This PR includes ${
releasePlan.changesets.length
? `changesets to release ${
- publishableReleases.length === 1
- ? "1 package"
- : `${publishableReleases.length} packages`
+ publishableReleases.length === 1 ? "1 package" : `${publishableReleases.length} packages`
}`
: "no changesets"
}
@@ -56,7 +50,7 @@ const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
const getAbsentMessage = (
commitSha: string,
addChangesetUrl: string,
- releasePlan: ReleasePlan | null
+ releasePlan: ReleasePlan | null,
) => `### ⚠️ No Changeset found
Latest commit: ${commitSha}
@@ -74,7 +68,7 @@ ${getReleasePlanMessage(releasePlan)}
const getApproveMessage = (
commitSha: string,
addChangesetUrl: string,
- releasePlan: ReleasePlan | null
+ releasePlan: ReleasePlan | null,
) => `### 🦋 Changeset detected
Latest commit: ${commitSha}
@@ -97,141 +91,121 @@ ${changedPackages.map((x) => `"${x}": patch`).join("\n")}
${title}
`);
-export type PRContext = EmitterWebhookEvent<
- "pull_request.opened" | "pull_request.synchronize"
-> &
+export type PRContext = EmitterWebhookEvent<"pull_request.opened" | "pull_request.synchronize"> &
Omit;
const getCommentId = (
context: PRContext,
- params: { repo: string; owner: string; issue_number: number }
+ params: { repo: string; owner: string; issue_number: number },
) =>
context.octokit.issues.listComments(params).then((comments) => {
const changesetBotComment = comments.data.find(
// TODO: find what the current user is in some way or something
(comment) =>
comment.user?.login === "changeset-bot[bot]" ||
- comment.user?.login === "changesets-test-bot[bot]"
+ comment.user?.login === "changesets-test-bot[bot]",
);
return changesetBotComment ? changesetBotComment.id : null;
});
const hasChangesetBeenAdded = (
- changedFilesPromise: ReturnType
+ changedFilesPromise: ReturnType,
) =>
changedFilesPromise.then((files) =>
files.data.some(
(file) =>
file.status === "added" &&
/^\.changeset\/.+\.md$/.test(file.filename) &&
- file.filename !== ".changeset/README.md"
- )
+ file.filename !== ".changeset/README.md",
+ ),
);
export default (app: Probot) => {
app.auth();
app.log("Yay, the app was loaded!");
- app.on(
- ["pull_request.opened", "pull_request.synchronize"],
- async (context) => {
- if (
- context.payload.pull_request.head.ref.startsWith("changeset-release")
- ) {
- return;
- }
-
- let errFromFetchingChangedFiles = "";
-
- try {
- let number = context.payload.number;
-
- let repo = {
- repo: context.payload.repository.name,
- owner: context.payload.repository.owner.login,
- };
+ app.on(["pull_request.opened", "pull_request.synchronize"], async (context) => {
+ if (context.payload.pull_request.head.ref.startsWith("changeset-release")) {
+ return;
+ }
- const latestCommitSha = context.payload.pull_request.head.sha;
- let changedFilesPromise = context.octokit.pulls.listFiles({
- ...repo,
- pull_number: number,
+ let errFromFetchingChangedFiles = "";
+
+ try {
+ let number = context.payload.number;
+
+ let repo = {
+ repo: context.payload.repository.name,
+ owner: context.payload.repository.owner.login,
+ };
+
+ const latestCommitSha = context.payload.pull_request.head.sha;
+ let changedFilesPromise = context.octokit.pulls.listFiles({
+ ...repo,
+ pull_number: number,
+ });
+
+ const [commentId, hasChangeset, { changedPackages, releasePlan }] = await Promise.all([
+ // we know the comment won't exist on opened events
+ // ok, well like technically that's wrong
+ // but reducing time is nice here so that
+ // deploying this doesn't cost money
+ context.payload.action === "synchronize"
+ ? getCommentId(context, { ...repo, issue_number: number })
+ : undefined,
+ hasChangesetBeenAdded(changedFilesPromise),
+ getChangedPackages({
+ repo: context.payload.pull_request.head.repo.name,
+ owner: context.payload.pull_request.head.repo.owner.login,
+ ref: context.payload.pull_request.head.ref,
+ changedFiles: changedFilesPromise.then((x) => x.data.map((x) => x.filename)),
+ octokit: context.octokit,
+ installationToken: (
+ await (await app.auth()).apps.createInstallationAccessToken({
+ installation_id: context.payload.installation!.id,
+ })
+ ).data.token,
+ }).catch((err) => {
+ if (err instanceof ValidationError) {
+ errFromFetchingChangedFiles = `💥 An error occurred when fetching the changed packages and changesets in this PR
\n\n\`\`\`\n${err.message}\n\`\`\`\n\n💥 An error occurred when fetching the changed packages and changesets in this PR
\n\n\`\`\`\n${err.message}\n\`\`\`\n\n