Skip to content

Commit

Permalink
Added changsets for version management (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
seanrcollings authored Nov 15, 2024
1 parent 05cd6b3 commit 41277e8
Show file tree
Hide file tree
Showing 10 changed files with 1,021 additions and 123 deletions.
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
58 changes: 0 additions & 58 deletions .github/workflows/release.yml

This file was deleted.

40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,43 @@ npm run playground
```bash
npm run test --workspaces
```

## Version Management

This repo uses [changsets](https://github.com/changesets/changesets/tree/main) for managing versions. To publish a new version of a package, follow these steps:

### Create a new changeset

Each time that you make meanginful changes to a package, you should create a new changeset. To do this, run the following command:
```bash
npx changeset
```

This will guide you through the process of creating a new changeset.

Once you have created a changeset, you can view it by running the following command:
```bash
npx changeset status
```

### Version

To publish a new version of a package, run the following command:

```bash
npx changeset version
```
This will consume all of the changesets that have been created and bump the versions of the packages accordingly.
Additionally, it will write changelog entries for each package.


### Publish

To publish the new versions of the packages, run the following command:

```bash
npx changeset publish
```

This will loop through all of the packages and publish any that have a newer version than what is on NPM.

Loading

0 comments on commit 41277e8

Please sign in to comment.