aprender 0.25.3

Next-generation machine learning library in pure 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

# GitHub Secrets Setup for Automated Releases

This guide explains how to configure GitHub secrets for automated crates.io publishing.

## Required Secrets

### CARGO_REGISTRY_TOKEN

This token is required for automated publishing to crates.io.

#### Steps to Configure:

1. **Get your crates.io API token:**
   - Log in to https://crates.io
   - Go to Account Settings: https://crates.io/me
   - Click "New Token" under "API Tokens"
   - Give it a name like "aprender-github-actions"
   - Copy the token (it won't be shown again!)

2. **Add token to GitHub Secrets:**
   - Go to your GitHub repository: https://github.com/paiml/aprender
   - Click "Settings" → "Secrets and variables" → "Actions"
   - Click "New repository secret"
   - Name: `CARGO_REGISTRY_TOKEN`
   - Value: Paste your crates.io token
   - Click "Add secret"

3. **Enable automatic publishing:**
   - Edit `.github/workflows/release.yml`
   - Find the `publish-crate` job
   - Uncomment the actual publish line:
     ```yaml
     - name: Publish to crates.io
       run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
     ```
   - Comment out or remove the dry-run line
   - Commit and push the changes

## Verification

To verify the secret is configured:

1. Go to Settings → Secrets and variables → Actions
2. You should see `CARGO_REGISTRY_TOKEN` listed
3. The value will be hidden (showing only `***`)

## Security Best Practices

- **Never commit tokens to git** - always use GitHub Secrets
- **Rotate tokens periodically** - create new tokens every 6-12 months
- **Use scoped tokens** - crates.io tokens can be scoped to specific crates
- **Monitor token usage** - check crates.io for API token activity

## Testing

Before enabling automatic publishing:

1. Test locally with dry-run:
   ```bash
   cargo publish --dry-run
   ```

2. Verify the release workflow works by creating a test tag:
   ```bash
   git tag test-v0.0.1
   git push origin test-v0.0.1
   ```

3. Check the GitHub Actions run completes successfully

4. Delete the test tag:
   ```bash
   git tag -d test-v0.0.1
   git push origin :refs/tags/test-v0.0.1
   ```

## Troubleshooting

### "Invalid token" error
- Regenerate token on crates.io
- Update GitHub secret with new token

### "Permission denied" error
- Ensure token has publish permissions
- Check crate ownership on crates.io

### Workflow doesn't trigger
- Ensure tag matches pattern `v*.*.*` (e.g., `v0.1.0`)
- Check workflow file syntax is valid YAML