srs-client 0.2.1

Provides bindings for the main functionalities of the SRS
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# Releasing

This document describes how to release a new version of `srs-client`.

## Quick Start

```bash
# For a patch release (0.2.0 → 0.2.1)
make release

# For a minor release (0.2.0 → 0.3.0)
make release.minor

# For a major release (0.2.0 → 1.0.0)
make release.major

# Preview changes without executing
make release.dry
```

## Prerequisites

- Ensure you have `cargo-release` and `git-cliff` installed:
  ```bash
  cargo install cargo-release git-cliff
  ```
- Clean working directory (all changes committed)
- On the `main` branch

## Automated Release (Recommended)

Using `cargo-release` which handles everything automatically:

### Patch Release
```bash
make release      # Same as make release.patch
make release.patch
```
- Bumps patch version (0.2.0 → 0.2.1)
- Updates changelog
- Updates README.md version references
- Creates git tag
- Pushes to GitHub
- Publishes to crates.io

### Minor Release
```bash
make release.minor
```
- Bumps minor version (0.2.0 → 0.3.0)
- Same automation as patch release

### Major Release
```bash
make release.major
```
- Bumps major version (0.2.0 → 1.0.0)
- Same automation as patch release

### Dry Run
```bash
make release.dry
```
- Preview all changes without executing
- Safe way to verify what will happen

## Manual Release

If you prefer more control over the process:

### Complete Manual Release
```bash
make release.manual
```
This will guide you through:
1. Checking for uncommitted changes
2. Prompting for new version number
3. Updating changelog with `git-cliff`
4. Committing changes
5. Creating git tag
6. Pushing to GitHub with tags
7. Reminder to publish to crates.io

### Step-by-Step Manual Release
```bash
# 1. Check working directory is clean
make release.check-changes

# 2. Update version (will prompt)
make release.update-version

# 3. Update changelog
make release.update-changelog

# 4. Commit changes
make release.commit

# 5. Create tag
make release.tag

# 6. Push to GitHub
make release.push

# 7. Publish to crates.io
make publish
```

## Post-Release

After release:
- The CI/CD pipeline automatically runs tests on the tagged version
- Documentation is built and validated
- The release appears on GitHub releases and crates.io

## Configuration

Release settings are configured in `Cargo.toml`:
- Version format and update rules
- Changelog generation with `git-cliff`
- README.md version updates
- Allowed release branch (`main`)

## Troubleshooting

### Release fails halfway
- Check the error message
- Fix the issue
- Run `make release.dry` to verify
- Try the release again

### Need to redo a release
```bash
# Delete the failed tag
git tag -d v0.2.1
git push origin :refs/tags/v0.2.1

# Start over
make release
```

### Working directory not clean
```bash
# Commit or stash changes
git add .
git commit -m "WIP"

# Or stash
git stash
```

Remember to always run `make release.dry` first if you're unsure about the changes!