Skip to content

Commit

Permalink
chore: remove release docs (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
achou11 authored Jan 13, 2025
1 parent 02c0231 commit f0147c6
Show file tree
Hide file tree
Showing 4 changed files with 154 additions and 2,154 deletions.
23 changes: 0 additions & 23 deletions CHANGELOG.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,3 @@ npm install
## Running tests

Unit tests can be run using `npm test` (or `npm t`).

## Releases

Currently releases are done locally via the CLI. We use [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) to handle version bumping and changelog generation.

Some helpful commands:

- `npx commit-and-tag-version --dry-run`: perform a dry-run release. If you're trying to figure out the desired options for performing a release, it's generally a good idea to specify this `--dry-run` flag for any command you do.

- `npx commit-and-tag-version`: create a release. This will bump the version and update the changelog file. At the end of the command's output it will tell you the command to run to actually push the changes and publish the release to npm. Usually it's something like:

```sh
Run `git push --follow-tags origin main` to publish
```

In order to publish to npm, you'll have to run the following:

```sh
npm publish --access=public
```
Loading

0 comments on commit f0147c6

Please sign in to comment.