Publish to crates.io with Proper Metadata

Intermediate12 min

Prepare, validate, and publish a Rust crate to crates.io with complete metadata, documentation, and versioning.

Prerequisites

-Rust toolchain installed
-crates.io account with API token
-A Cargo project ready for publishing

Steps

Login to crates.io

Authenticate with crates.io using your API token from the website.

$ cargo login

Get your token from https://crates.io/settings/tokens. The token is stored in ~/.cargo/credentials.toml.

Ensure required metadata is set

Verify that Cargo.toml has all fields required for publishing.

$ cargo read-manifest | jq '{name, version, description, license, repository}'

Publishing requires at minimum: name, version, description, and license. Missing fields will cause publish to fail.

Generate and review documentation

Build documentation locally and verify it looks correct before publishing.

$ cargo doc --no-deps --open

Dry-run the publish

Validate the crate package without actually uploading it.

$ cargo publish --dry-run

This catches missing files, invalid metadata, and build errors before the real publish.

Publish the crate

Upload the crate to crates.io for the world to use.

$ cargo publish

Published versions cannot be deleted or overwritten. Double-check the version number before publishing.

Full Script

full-script.sh

#!/bin/bash
# Publish Rust Crate to crates.io
set -euo pipefail

echo "=== Pre-Publish Checklist ==="
echo "Checking metadata..."
cargo read-manifest | jq '{name, version, description, license, repository}' 2>/dev/null || cargo metadata --format-version 1 | jq '.packages[0] | {name, version, description, license, repository}'

echo ""
echo "=== Running Tests ==="
cargo test

echo ""
echo "=== Clippy Check ==="
cargo clippy -- -D warnings

echo ""
echo "=== Dry Run ==="
cargo publish --dry-run

echo ""
echo "=== Ready to Publish ==="
echo "Run 'cargo publish' to upload to crates.io"
echo ""
echo "=== Publish Commands ==="
echo "Login:    cargo login"
echo "Dry run:  cargo publish --dry-run"
echo "Publish:  cargo publish"
echo "Yank:     cargo yank --version 1.0.0"
echo "Unyank:   cargo yank --version 1.0.0 --undo"

FAQ

Discussion

Loading comments...

#!/bin/bash # Publish Rust Crate to crates.io set -euo pipefail echo "=== Pre-Publish Checklist ===" echo "Checking metadata..." cargo read-manifest | jq '{name, version, description, license, repository}' 2>/dev/null || cargo metadata --format-version 1 | jq '.packages[0] | {name, version, description, license, repository}' echo "" echo "=== Running Tests ===" cargo test echo "" echo "=== Clippy Check ===" cargo clippy -- -D warnings echo "" echo "=== Dry Run ===" cargo publish --dry-run echo "" echo "=== Ready to Publish ===" echo "Run 'cargo publish' to upload to crates.io" echo "" echo "=== Publish Commands ===" echo "Login: cargo login" echo "Dry run: cargo publish --dry-run" echo "Publish: cargo publish" echo "Yank: cargo yank --version 1.0.0" echo "Unyank: cargo yank --version 1.0.0 --undo"