Skip to content

Commit 0dd10b2

Browse files
author
Fredrik Fornwall
authored
Move puffin changelog and release.toml to puffin/ (#196)
Also add a section to the README about releasing.
1 parent 375f476 commit 0dd10b2

File tree

4 files changed

+17
-10
lines changed

4 files changed

+17
-10
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,13 @@ We welcome community contributions to this project.
7575

7676
Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
7777

78+
## Releasing
79+
80+
We use the [cargo release](https://github.com/crate-ci/cargo-release) tool to manage changelogs, git tags and publishing crates.
81+
82+
Each substantial pull request should add a changelog entry under the `[Unreleased]` section (see [keep a changelog](https://keepachangelog.com)
83+
and previous changelog entries). The crate version in `Cargo.toml` is never updated manually in a PR as it's handled by `cargo release`.
84+
7885
## License
7986

8087
Licensed under either of
File renamed without changes.

puffin/release.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
pre-release-commit-message = "Release puffin-{{version}}"
2+
tag-message = "Release puffin-{{version}}"
3+
tag-name = "puffin-{{version}}"
4+
pre-release-replacements = [
5+
{ file = "CHANGELOG.md", search = "Unreleased", replace = "{{version}}" },
6+
{ file = "CHANGELOG.md", search = "\\.\\.\\.HEAD", replace = "...{{tag_name}}" },
7+
{ file = "CHANGELOG.md", search = "ReleaseDate", replace = "{{date}}" },
8+
{ file = "CHANGELOG.md", search = "<!-- next-header -->", replace = "<!-- next-header -->\n## [Unreleased] - ReleaseDate" },
9+
{ file = "CHANGELOG.md", search = "<!-- next-url -->", replace = "<!-- next-url -->\n[Unreleased]: https://github.com/EmbarkStudios/puffin/compare/{{tag_name}}...HEAD" },
10+
]

release.toml

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)