Skip to content

Add release workflow and documentation#16

Merged
martinabeleda merged 4 commits intomainfrom
codex/linear-mention-mab-11-deploy-ripdiff-to-cargo
Mar 14, 2026
Merged

Add release workflow and documentation#16
martinabeleda merged 4 commits intomainfrom
codex/linear-mention-mab-11-deploy-ripdiff-to-cargo

Conversation

@martinabeleda
Copy link
Owner

@martinabeleda martinabeleda commented Mar 14, 2026

Motivation

  • Prepare ripdiff for automated crates.io releases with a maintainer workflow that keeps the crate version and git tag in sync.
  • Move maintainer-only release procedures out of the user-facing README.md into a dedicated release guide.

Description

  • Add a tag-driven GitHub Actions workflow at .github/workflows/release.yml that validates the pushed v* tag against Cargo.toml, runs cargo package, publishes with cargo publish --locked, and creates a GitHub release.
  • Add release.toml to configure cargo-release as the maintainer entry point for releases: create vX.Y.Z tags, push to origin, and leave publishing to CI.
  • Add RELEASING.md to document the release process, including the cargo-release workflow, the main-only release policy, and the required CARGO_REGISTRY_TOKEN secret.
  • Update README.md to link to RELEASING.md instead of carrying maintainer release instructions inline.

Testing

  • No additional code tests were run for this documentation and release configuration update.
  • Verified that the documented cargo-release tag format (v{{version}}) matches the GitHub Actions trigger and tag/version validation logic.

Codex Task

@martinabeleda martinabeleda changed the title Add crates.io metadata, README install/release docs, and release workflow Add release workflow and documentation Mar 14, 2026
@martinabeleda martinabeleda merged commit b1bd963 into main Mar 14, 2026
4 checks passed
@martinabeleda martinabeleda deleted the codex/linear-mention-mab-11-deploy-ripdiff-to-cargo branch March 14, 2026 04:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant