diff --git a/README.md b/README.md index af88efe2..bdba23af 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,16 @@ We welcome community contributions to this project. Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started. +## Releasing + +We use the [cargo release](https://github.com/crate-ci/cargo-release) tool to manage changelogs, git tags and crate publishing. + +Each substantial pull request should have a changelog entry (see [keep a changelog](https://keepachangelog.com)) and never update +a crate version directly. + +Once it's time to release `cargo release` is used to release each crate separately, which will update the crate version and +the changelog, create a git tag and publish the crate. + ## License Licensed under either of diff --git a/CHANGELOG.md b/puffin/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to puffin/CHANGELOG.md diff --git a/puffin/release.toml b/puffin/release.toml new file mode 100644 index 00000000..b9379f8a --- /dev/null +++ b/puffin/release.toml @@ -0,0 +1,10 @@ +pre-release-commit-message = "Release puffin-{{version}}" +tag-message = "Release puffin-{{version}}" +tag-name = "puffin-{{version}}" +pre-release-replacements = [ + { file = "CHANGELOG.md", search = "Unreleased", replace = "{{version}}" }, + { file = "CHANGELOG.md", search = "\\.\\.\\.HEAD", replace = "...{{tag_name}}" }, + { file = "CHANGELOG.md", search = "ReleaseDate", replace = "{{date}}" }, + { file = "CHANGELOG.md", search = "", replace = "\n## [Unreleased] - ReleaseDate" }, + { file = "CHANGELOG.md", search = "", replace = "\n[Unreleased]: https://github.com/EmbarkStudios/puffin/compare/{{tag_name}}...HEAD" }, +] diff --git a/release.toml b/release.toml deleted file mode 100644 index c033cf0c..00000000 --- a/release.toml +++ /dev/null @@ -1,10 +0,0 @@ -pre-release-commit-message = "Release puffin-{{version}}" -tag-message = "Release puffin-{{version}}" -tag-name = "{{version}}" -pre-release-replacements = [ - { file = "../CHANGELOG.md", search = "Unreleased", replace = "{{version}}" }, - { file = "../CHANGELOG.md", search = "\\.\\.\\.HEAD", replace = "...{{tag_name}}" }, - { file = "../CHANGELOG.md", search = "ReleaseDate", replace = "{{date}}" }, - { file = "../CHANGELOG.md", search = "", replace = "\n## [Unreleased] - ReleaseDate" }, - { file = "../CHANGELOG.md", search = "", replace = "\n[Unreleased]: https://github.com/EmbarkStudios/puffin/compare/{{tag_name}}...HEAD" }, -]