balancer-maths-rust 0.4.3

Balancer V3 mathematics library in Rust
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

# Release Guide for balancer-maths-rust

This guide covers the process for releasing new versions of the `balancer-maths-rust` package on crates.io.

## Prerequisites

1. **Crates.io Account**: Ensure you have a crates.io account and are a maintainer of the package
2. **Cargo Login**: Run `cargo login` to authenticate with crates.io
3. **Git Access**: Ensure you have push access to the repository

## Pre-Release Checklist

Before creating a release, ensure the following:

### 1. Code Quality

-   [ ] All tests pass: `cargo test`
-   [ ] Clippy checks pass: `cargo clippy --all-targets --all-features -- -D warnings`
-   [ ] Formatting passes: `cargo fmt --all -- --check`
-   [ ] Check for unused dependencies: `cargo check --all-targets --all-features`

### 2. Documentation

-   [ ] README.md is up to date
-   [ ] All public APIs are documented
-   [ ] Examples are working and documented
-   [ ] CHANGELOG.md is updated with new features/fixes

### 3. Version Management

-   [ ] Update version in `Cargo.toml`
-   [ ] Update version in documentation if needed
-   [ ] Ensure semantic versioning is followed

## Release Process

### Step 1: Update Version

1. **Edit `Cargo.toml`**:

    ```toml
    [package]
    name = "balancer-maths-rust"
    version = "0.1.1"  # Increment version number
    ```

2. **Update CHANGELOG.md** (if not already done):

    ```markdown
    ## [0.1.1] - 2024-01-XX

    ### Added

    -   New feature description

    ### Changed

    -   Breaking change description

    ### Fixed

    -   Bug fix description
    ```

### Step 2: Build for release

1. **Build for release**:

    ```bash
    cargo build --release
    ```

### Step 3: Commit and Tag

1. **Commit changes**:

    ```bash
    git add .
    git commit -m "Release v0.1.1"
    ```

### Step 4: Publish to Crates.io

1. **Dry run** (optional but recommended):

    ```bash
    cargo package
    ```

2. **Publish**:

    ```bash
    cargo publish
    ```

3. **Verify publication**:
    - Check [crates.io](https://crates.io/crates/balancer-maths-rust)
    - Verify the new version appears
    - Test installation: `cargo install balancer-maths-rust`

## Post-Release Tasks

1. **Update Repository**

-   [ ] Push all changes to main branch

## Troubleshooting

### Rollback Procedure

If a release needs to be rolled back:

1. **Yank the version** (if published):

    ```bash
    cargo yank --version 0.1.1
    ```

2. **Create a new patch release** with fixes:

    - Increment patch version
    - Fix the issues
    - Follow normal release process

3. **Communicate with users**:
    - Update documentation
    - Notify users of the issue and fix