dotstate 0.2.3

A modern, secure, and user-friendly dotfile manager built with 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
128
129
130
131
132
133
134
135
136

# Publishing Guide

This document outlines the steps to publish DotState to various package managers and platforms.

## Pre-Release Checklist

- [ ] Update version in `Cargo.toml`
- [ ] Update `CHANGELOG.md` with release notes
- [ ] Update `README.md` if needed
- [ ] Run full test suite: `cargo test`
- [ ] Run clippy: `cargo clippy -- -D warnings`
- [ ] Check formatting: `cargo fmt -- --check`
- [ ] Build release: `cargo build --release`
- [ ] Test release binary locally
- [ ] Create git tag: `git tag -a v0.1.0 -m "Release v0.1.0"`
- [ ] Push tag: `git push origin v0.1.0`

## Publishing to crates.io

1. **Create account** on [crates.io](https://crates.io)
2. **Get API token** from account settings
3. **Login**:
   ```bash
   cargo login YOUR_API_TOKEN
   ```
4. **Publish**:
   ```bash
   cargo publish
   ```

Note: Publishing to crates.io is permanent. Make sure everything is correct!

## Publishing to Homebrew

### Initial Setup

1. **Fork** [homebrew-core](https://github.com/Homebrew/homebrew-core) (or create your own tap)
2. **Create formula** in `Formula/dotstate.rb`
3. **Calculate SHA256**:
   ```bash
   # After creating a release on GitHub
   wget https://github.com/serkanyersen/dotstate/archive/v0.1.0.tar.gz
   shasum -a 256 v0.1.0.tar.gz
   ```
4. **Update formula** with the SHA256
5. **Test locally**:
   ```bash
   brew install --build-from-source Formula/dotstate.rb
   ```
6. **Submit PR** to homebrew-core (or merge to your tap)

### Creating Your Own Tap

1. **Create repository** `homebrew-dotstate` on GitHub
2. **Add formula** to the repository
3. **Users install** with:
   ```bash
   brew tap serkanyersen/dotstate
   brew install dotstate
   ```

   Or use the direct install:
   ```bash
   brew install serkanyersen/dotstate/dotstate
   ```

## GitHub Releases

1. **Create release** on GitHub:
   - Go to Releases → Draft a new release
   - Tag: `v0.1.0`
   - Title: `v0.1.0`
   - Description: Copy from `CHANGELOG.md`
2. **Upload binaries** (optional, for direct downloads):
   - Build for multiple platforms
   - Upload `.tar.gz` or `.zip` files
3. **Publish release**

## Building Binaries for Distribution

### macOS

```bash
# Build for Apple Silicon
cargo build --release --target aarch64-apple-darwin

# Build for Intel
cargo build --release --target x86_64-apple-darwin
```

### Linux

```bash
# Build for x86_64
cargo build --release --target x86_64-unknown-linux-gnu

# Or use Docker for consistent builds
docker run --rm -v $(pwd):/app -w /app rust:latest cargo build --release
```

### Cross-compilation

Install cross-compilation targets:
```bash
rustup target add aarch64-apple-darwin
rustup target add x86_64-unknown-linux-gnu
```

## Version Bumping

When releasing a new version:

1. **Update `Cargo.toml`**:
   ```toml
   version = "0.1.1"
   ```

2. **Update `CHANGELOG.md`**:
   - Move items from `[Unreleased]` to new version section
   - Add release date

3. **Commit and tag**:
   ```bash
   git add Cargo.toml CHANGELOG.md
   git commit -m "Bump version to 0.1.1"
   git tag -a v0.1.1 -m "Release v0.1.1"
   git push origin main --tags
   ```

## Post-Release

- [ ] Announce on social media (if desired)
- [ ] Update documentation if needed
- [ ] Monitor issues and feedback
- [ ] Plan next release