Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions .github/actions/ci-setup/action.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
name: Setup CI
description: Setup Node and project dependencies using yarn
description: Sets up pnpm, Node.js, and installs dependencies

runs:
using: composite
steps:
- name: Setup Node.js 24
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
- name: Set up pnpm
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5

- name: Set up Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 24
cache: yarn
cache: pnpm

- name: Install dependencies
shell: bash
run: yarn install --frozen-lockfile --ignore-scripts
run: pnpm install --frozen-lockfile
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
uses: ./.github/actions/ci-setup

- name: Run test
run: yarn test
run: pnpm test

lint:
name: Lint
Expand All @@ -44,16 +44,16 @@ jobs:
uses: ./.github/actions/ci-setup

- name: Run format:check
run: yarn format:check
run: pnpm format:check

- name: Run lint
run: yarn lint:js:ci
run: pnpm lint:js:ci

- name: Run knip
run: yarn lint:knip
run: pnpm lint:knip

- name: Run typecheck
run: yarn typecheck
run: pnpm typecheck

ci-ok:
name: CI OK
Expand Down
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

## Setup

```sh
pnpm install
```

## Scripts

| Script | Description |
| ------------------- | ------------------------------------- |
| `pnpm test` | Run the test suite |
| `pnpm typecheck` | Type-check the codebase |
| `pnpm lint` | Run all linters (JS + unused exports) |
| `pnpm lint:js:fix` | Auto-fix lint issues |
| `pnpm format` | Format source files |
| `pnpm format:check` | Check formatting without writing |

## Behaviour

The changeset bot will listen for pull requests being opened and pull requests that have been updated,
upon which it will then scan through the files for a changeset that has been added.

The bot will make a comment on the PR stating whether it found a changeset or not, as well as the message of the latest commit.\
If the PR is being updated then the bot will update the existing comment
25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# changeset-bot

> A GitHub App built with [Probot](https://github.com/probot/probot) to detect [changesets](https://github.com/atlassian/changesets) in PRs
A GitHub App built with [Probot](https://github.com/probot/probot) to detect [changesets](https://github.com/atlassian/changesets) in PRs

## Install the bot at https://github.com/apps/changeset-bot
## Install

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.
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.

<img width="1552" alt="screenshot of changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 before a changeset was added" src="https://user-images.githubusercontent.com/11481355/66183943-dc418680-e6bd-11e9-998d-e43f90a974bd.png">

Expand All @@ -18,7 +20,7 @@ Sometimes, a contributor won't add a changeset to a PR but you might want to mer

<img width="1552" alt="screenshot of the GitHub file creation page focusing on the commit button" src="https://user-images.githubusercontent.com/11481355/66184181-a94bc280-e6be-11e9-85fc-32edcd5b05ce.png">

<img width="1552" alt="screenshot of the changeset bot message from https://github.com/mitchellhamilton/manypkg/pull/18 showing the changeset good to go message" src="https://user-images.githubusercontent.com/11481355/66184229-cf716280-e6be-11e9-950e-0f64a31dbf15.png">
## Changeset format

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.

Expand All @@ -33,17 +35,4 @@ A very helpful description of the changes

---

The information below is for contributing to the bot.

## Setup

```sh
yarn
```

## Behaviour

The changeset bot will listen for pull requests being opened and pull requests that have been updated, upon which it will
then scan through the files for a changeset that has been added. The bot will make a comment on the PR stating
whether it found a changeset or not, as well as the message of the latest commit. If the PR is being updated
then the bot will update the existing comment
For information on contributing to the bot, see [CONTRIBUTING.md](./CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"scripts": {
"format": "oxfmt",
"format:check": "oxfmt --check",
"lint": "yarn lint:js && yarn lint:knip",
"lint": "pnpm lint:js && pnpm lint:knip",
"lint:js": "oxlint",
"lint:js:fix": "oxlint --fix",
"lint:js:ci": "oxlint --format=github",
Expand Down Expand Up @@ -46,5 +46,5 @@
"vite": "^8.0.3",
"vitest": "^4.1.2"
},
"packageManager": "yarn@1.22.22"
"packageManager": "pnpm@11.0.9+sha512.34ce82e6780233cf9cad8685029a8f81d2e06196c5a9bad98879f7424940c6817c4e4524fb7d38b8553ceed48b9758b8ebaf1abd3600c232c4c8cf7366086f38"
}
Loading