PUBLISHING.md

Publishing Checklist

This checklist helps ensure a smooth release process for Credify.

Pre-release Checklist

• All tests pass: cargo test --all
• Code is properly formatted: cargo fmt --all -- --check
• No clippy warnings: cargo clippy --all-targets --all-features -- -D warnings
• Documentation builds: cargo doc --no-deps
• Examples run successfully:
  • cargo run --example basic
  • cargo run --example batch_validation
  • cargo run --example llm_friendly
  • cargo run --example llm_simple
• CHANGELOG.md is updated with new version
• Version number in Cargo.toml is updated (now v0.2.0)
• README.md badges point to correct URLs
• New LLM validation functions documented
• Verbose output format documented

Publishing to crates.io

1. Dry run to check everything:

   cargo publish --dry-run

2. Login to crates.io (if not already):

   cargo login

3. Publish to crates.io:

   cargo publish

Publishing to GitHub

1. Create and push a git tag:

   git tag -a v0.2.0 -m "Release version 0.2.0 - Enhanced LLM support with verbose validation reports"
   git push origin v0.2.0

2. GitHub Actions will automatically:

   • Run all tests
   • Create a GitHub release
   • Publish to crates.io (if CRATES_TOKEN secret is set)

Post-release

• Verify the crate appears on https://crates.io/crates/credify
• Check that documentation is available at https://docs.rs/credify
• Update any dependent projects
• Announce the release (Twitter, Reddit, etc.)

Setting up GitHub Secrets

For automatic publishing, add these secrets to your GitHub repository:

1. Go to Settings � Secrets � Actions
2. Add CRATES_TOKEN with your crates.io API token

To get your crates.io token:

1. Login at https://crates.io
2. Go to Account Settings � API Tokens
3. Create a new token with publish permissions