Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove release docs #41

Merged
merged 1 commit into from
Jan 13, 2025
Merged

chore: remove release docs #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 0 additions & 23 deletions CHANGELOG.md
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions docs/CONTRIBUTING.md
View file
Open in desktop
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
Loading