Skip to content

feat: prepare crates for publishing to crates.io - #14

Open
includeamin wants to merge 1 commit into
mainfrom
crates-io-publish
Open

includeamin wants to merge 1 commit into
mainfrom
crates-io-publish

Conversation

@includeamin

Copy link
Copy Markdown
Owner

Summary

  • Add repository, homepage, keywords, categories and readme metadata to the publishable crates.
  • Give the workspace openapi-aggregator-core dependency a registry version, and keep it in sync in tag-release.yml.
  • Add crate-level docs (with a doctest) and fix the README library example indentation.
  • Add a manual publish.yml workflow that publishes core, then the CLI/library crate. It defaults to a dry run.

Notes

  • cargo publish --dry-run passes for openapi-aggregator-core. The CLI crate can't be dry-run until core is on the registry.
  • Needs a CARGO_REGISTRY_TOKEN repo secret before a real publish.
  • No rust-version is set; the MSRV hasn't been verified.

Test plan

  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test --all-features
  • Run the Publish workflow with dry_run enabled

Add package metadata, a registry version on the core dependency, crate
docs with a doctest, and a manual publish workflow (dry run by default).
The release workflow now keeps the core dependency version in sync.

This branch has not been deployed

No deployments
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