Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.62 KB

PUBLISHING.md

File metadata and controls

25 lines (16 loc) · 1.62 KB

Rules for Publishing

(This document is intended for maintainers)

Rules for Publishing

Publishing is done off of the master branch.

This project adheres to Semantic Versioning, and versions should always adhere to those standards.

The versions of the Python Wheel and Rust Crate should be the same.

Steps to Publish a Rust Version

  1. The new version should be already committed to master in all Cargo.toml files under ./lace/
  2. The notes for the new version should be committed to CHANGELOG.md.
  3. A tag of the form rust-{VERSION} should be pushed to the curret master, with {VERSION} matching the new version tag. Only maintainers should be able to do this.
  4. The GitHub Action workflow will build and deploy to crates.io. The guide and other relevant documentation will also be deployed to the GitHub Pages site at lace.dev.

Steps to Publish a New Version

  1. The new version should be already committed to master in all Cargo.toml and pyproject.toml files under ./pylace/
  2. The notes for the new version should be committed to CHANGELOG.md.
  3. A tag of the form python-{VERSION} should be pushed to the curret master, with {VERSION} matching the new version tag. Only maintainers should be able to do this.
  4. The GitHub Action workflow will build and deploy to PyPi automatically. The guide and other relevant documentation will also be deployed to the GitHub Pages site at lace.dev, and Python documentation will be built by ReadTheDocs