crate release

크레이트 배포 전 공개 API 점검

문서 테스트로 사용법을 검증하고, pub use와 메타데이터를 정리한 뒤 publish와 yank까지 운영 절차로 묶습니다.

배포 흐름

///와 //! 문서화 주석으로 사용자 관점의 사용법을 먼저 설명합니다.

Examples 코드는 cargo test에서 실행되어 문서와 코드의 어긋남을 잡습니다.

내부 모듈 구조가 복잡하면 pub use로 더 짧은 공개 경로를 제공합니다.

description, license, repository 같은 crates.io 필수 정보를 채웁니다.

토큰으로 로그인한 뒤 cargo publish와 버전 관리, yank 기준을 확인합니다.

릴리즈 체크

Panics, Errors, Safety는 호출자가 실수하기 쉬운 조건을 명시할 때 우선 사용합니다.

사용자가 외워야 할 모듈 깊이를 줄이면 crate::UsefulType처럼 읽기 쉬운 API가 됩니다.

검색과 신뢰에 영향을 주는 설명, 라이선스, 문서 링크를 배포 전에 고정합니다.

기존 사용자를 깨뜨리지 않도록 의미 있는 변경 단위로 새 버전을 올립니다.

이미 내려받은 코드는 유지되므로 보안·오작동 버전의 신규 선택만 막는 용도로 씁니다.

release cue

배포는 cargo publish 한 줄이 아니라 문서, 공개 API, 메타데이터, 버전 정책을 동시에 잠그는 절차입니다.