# Publishing Checklist
This document complements `docs/build_and_release.md` with the Port-specific steps required for a
successful `cargo publish`.
1. **Credentials** – ensure you have a crates.io API token stored in `~/.cargo/credentials`.
2. **Dependency audit** – run `cargo audit` and triage any advisories.
3. **Schema sync** – refresh `schemas/port.swagger.json` from Port's latest OpenAPI document and
commit the change. Confirm the generated SHA in `PortConfig::schema_sha256()` updates.
4. **Examples** – execute the Markdown examples manually (copy into a throwaway binary crate) to
confirm they still compile after API changes.
5. **Docs.rs preview** – run `RUSTDOCFLAGS="--cfg docsrs" cargo doc --no-deps` to ensure
documentation compiles in the docs.rs environment.
6. **Metadata audit** – double-check `Cargo.toml` for accurate license, repository, keywords, and
categories.
7. **Version bump** – update `Cargo.toml`, `CHANGELOG.md`, and tag the release.
8. **Dry run** – `cargo publish --dry-run` should succeed.
9. **Publish & announce** – run `cargo publish`, push tags, and update the release notes using
`docs/release_announcement.md` as a template.
Keep `SECURITY.md` up to date with your disclosure policy before every release.