chore: prepare crates for crates.io publishing#199
Merged
Conversation
- Update LICENSE copyright: 2024-2025 Parres → 2024-2026 Internet Privacy Foundation - Copy LICENSE into each publishable crate directory (required for crates.io packaging) - Fix broken ../../LICENSE links in all crate READMEs → local LICENSE file - Remove stale rust-nostr branding/donation sections from all crate READMEs - Replace NIP-EE reference in mdk-core README with Marmot Protocol link - Expand mdk-sqlite-storage and mdk-storage-traits READMEs with proper content - Update workspace README version examples: 0.5.0 → 0.6.0 - Merge unreleased changelog entries into [0.6.0] in mdk-core and mdk-uniffi - Fix stale "JSON codec" sub-bullet in mdk-memory-storage and mdk-sqlite-storage changelogs
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (17)
📝 WalkthroughWalkthroughThis PR prepares the 0.6.0 release by updating copyright ownership to Internet Privacy Foundation, bumping crate versions, removing CodeQL workflows, adding automated crates.io publication pipeline, distributing MIT licenses across crates, and refreshing documentation across all crate READMEs and CHANGELOGs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Coverage: 91.07% → 91.08% (+0.01%) |
Publishes crates to crates.io in dependency order when a GitHub release is published: mdk-storage-traits first, then mdk-memory-storage and mdk-sqlite-storage in parallel, then mdk-core last.
|
Rustdoc inlines the crate README and attempts to resolve [LICENSE](LICENSE) as a Rust intra-doc link, causing a broken-intra-doc-links error under -D warnings. Use the full GitHub URL instead.
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepares all publishable crates (
mdk-core,mdk-storage-traits,mdk-memory-storage,mdk-sqlite-storage) for first publish to crates.io.Changes
License
2024-2025 Parres→2024-2026 Internet Privacy FoundationLICENSEinto each publishable crate directory — required sincecargo publishonly packages files within the crate's own directory treeREADMEs (crate-level)
../../LICENSErelative links (work in the repo, break on crates.io) → point to localLICENSEcopyrust-nostrdonation sections from all four crate READMEsNIP-EEdraft PR reference inmdk-coreREADME with Marmot Protocol linkmdk-sqlite-storageREADME with features, all three usage patterns (keyring, manual key, unencrypted)mdk-storage-traitsREADME with ecosystem crate linksWorkspace README
0.5.0→0.6.0Changelogs
clear_pending_commitentries into[0.6.0]inmdk-coreandmdk-uniffi(no git tag exists yet for 0.6.0, so this is the right approach)mdk-memory-storageandmdk-sqlite-storagechangelogs → "Postcard codec (MlsCodec)" to reflect what actually shippedPublishing order (after merge + tag)
This PR prepares four MDK crates (mdk-core, mdk-storage-traits, mdk-memory-storage, mdk-sqlite-storage) for initial crates.io publication by updating license ownership, fixing documentation, consolidating changelog entries, and establishing a CI/CD publishing workflow. It establishes the foundation for automated crate releases with proper licensing, documentation, and metadata aligned with crates.io publishing standards.
What changed:
Security impact:
Protocol changes: