From 8f050b40c1d3bd87d2c5fc69dc3e5aba73bc573c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?alub=E1=BB=8Dsa?= <48127194+kaf-lamed-beyt@users.noreply.github.com> Date: Wed, 26 Jul 2023 17:30:58 +0100 Subject: [PATCH] chore(docs): add changeset guide to contributing.md (#219) * chore(docs): add changeset guide to contributing.md * chore: text changes to changeset guide * Update CONTRIBUTING.md --------- Co-authored-by: Eric Allam --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edcc9226c..36acc9ef8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -175,6 +175,26 @@ The [examples/jobs-starter](./examples/jobs-starter/) project defines simple job ](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - Be sure to fill the PR Template accordingly. +## Adding changesets + +We use [changesets](https://github.com/changesets/changesets) to manage our package versions and changelogs. If you've never used changesets before, first read [their guide here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md). + +If you are contributing a change to any packages in this monorepo (anything in either the `/packages` or `/integrations` directories), then you will need to add a changeset to your Pull Requests before they can be merged. + +To add a changeset, run the following command in the root of the repo + +```shell +pnpm run changeset:add +``` + +Here's an example of creating a `patch` changeset for the `@trigger.dev/github` and `@trigger.dev/slack` packages (click to view): + +[![asciicast](https://asciinema.org/a/599228.svg)](https://asciinema.org/a/599228) + +You will be prompted to select which packages to include in the changeset. Only select the packages that you have made changes for (Important: never include a changeset for the `@trigger.dev/internal` package, as it's bundled with other packages and should not be published). + +Most of the time the changes you'll make are likely to be categorized as patch releases. If you feel like there is the need for a minor or major release of the package based on the changes being made, add the changeset as such and it will be discussed during PR review. + ## Troubleshooting ### EADDRINUSE: address already in use :::3030