Skip to content

Commit

Permalink
Move puffin changelog and release.toml to puffin/
Browse files Browse the repository at this point in the history
Also add a section to the README about releasing.
  • Loading branch information
fornwall committed Feb 16, 2024
1 parent 375f476 commit a644ce4
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
10 changes: 10 additions & 0 deletions puffin/release.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
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 = "<!-- next-header -->", replace = "<!-- next-header -->\n## [Unreleased] - ReleaseDate" },
{ file = "CHANGELOG.md", search = "<!-- next-url -->", replace = "<!-- next-url -->\n[Unreleased]: https://github.com/EmbarkStudios/puffin/compare/{{tag_name}}...HEAD" },
]
10 changes: 0 additions & 10 deletions release.toml

This file was deleted.

0 comments on commit a644ce4

Please sign in to comment.