Skip to content

chore: prepare for crates.io publish#9

Merged
aWN4Y25pa2EK merged 1 commit into
mainfrom
chore/crates-io-publish
Jan 21, 2026
Merged

chore: prepare for crates.io publish#9
aWN4Y25pa2EK merged 1 commit into
mainfrom
chore/crates-io-publish

Conversation

@aWN4Y25pa2EK
Copy link
Copy Markdown
Member

Summary

Prepare m2m-protocol for publishing to crates.io.

Changes

  • Rename package: m2m-corem2m-protocol (matches repo name, more discoverable)
  • Keywords: Reduce from 6 to 5 (crates.io limit)
  • MSRV: Upgrade to Rust 1.88
  • Docs: Fix HTML tag warning in brotli.rs docstring
  • README: Update badge URLs to m2m-protocol
  • CI: Add publish workflow (.github/workflows/publish.yml)

Publish Workflow

The new workflow:

  • Triggers on GitHub Release (auto) or manual dispatch
  • Runs cargo publish --dry-run verification
  • Uses CARGO_REGISTRY_TOKEN secret for authentication

Post-Merge Steps

  1. Add GitHub Secret:

    • Go to: Settings → Secrets → Actions
    • Name: CARGO_REGISTRY_TOKEN
    • Value: (crates.io API token)
  2. First Publish:

    • Option A: Create a GitHub Release (auto-triggers publish)
    • Option B: Manual dispatch with dry_run: false

Verification

  • cargo publish --dry-run passes
  • All tests pass
  • m2m-protocol name available on crates.io

- Rename package from m2m-core to m2m-protocol
- Reduce keywords to 5 (crates.io limit)
- Upgrade MSRV to 1.88
- Fix HTML tag warning in brotli.rs docstring
- Update README badge URLs
- Add GitHub Actions workflow for publishing

The publish workflow:
- Triggers on GitHub Release or manual dispatch
- Runs dry-run verification before actual publish
- Uses CARGO_REGISTRY_TOKEN secret for authentication
@aWN4Y25pa2EK aWN4Y25pa2EK merged commit 6ada8e9 into main Jan 21, 2026
2 of 4 checks passed
@aWN4Y25pa2EK aWN4Y25pa2EK deleted the chore/crates-io-publish branch January 21, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant