Skip to content

Commit

Permalink
Document tagging/release process
Browse files Browse the repository at this point in the history
  • Loading branch information
tjk committed Nov 20, 2024
1 parent fb5a4aa commit acad378
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,41 @@ cargo test

Contributions are welcome! Please feel free to submit a Pull Request.

## Publishing

To publish a new version:

1. Update the version in `Cargo.toml`
2. Update CHANGELOG.md
3. Commit the changes
4. Create a new version tag:
```bash
git tag -a v0.1.0 -m "Release version 0.1.0"
```
5. Push the tag:
```bash
git push origin v0.1.0
```

The GitHub Action will automatically:
1. Verify the version matches the tag
2. Run all tests
3. Publish to crates.io
4. Create a GitHub release

### Publishing Manually

If you need to publish manually:

```bash
# Verify everything works
cargo test
cargo publish --dry-run

# Publish to crates.io
cargo publish
```

## License

This project is licensed under the MIT License - see the LICENSE file for details.

0 comments on commit acad378

Please sign in to comment.