bgzf 0.4.0

Utility library for working with explicitly BGZF compressed data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Releasing

This document describes how to release a new version of bgzf.

## Prerequisites

1. Ensure you have push access to the repository
2. Ensure `CARGO_REGISTRY_TOKEN` secret is configured in GitHub repository settings

## Release Process

1. Update `CHANGELOG.md` with the release date and any final changes

2. Update version in `Cargo.toml`:
   ```toml
   version = "X.Y.Z"
   ```

3. Commit the version bump:
   ```bash
   git add Cargo.toml CHANGELOG.md
   git commit -m "chore: release vX.Y.Z"
   ```

4. Create and push a tag:
   ```bash
   git tag vX.Y.Z
   git push origin main --tags
   ```

5. The GitHub Action will automatically:
   - Publish to crates.io
   - Create a GitHub Release with auto-generated notes

## Version Guidelines

- **Major (X.0.0)**: Breaking API changes
- **Minor (0.X.0)**: New features, deprecations
- **Patch (0.0.X)**: Bug fixes, performance improvements