Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[changelog]
header = """
# Changelog

"""
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}]
{% else %}\
## [unreleased]
{% endif %}\
{% for commit in commits %}
- {% if commit.remote.pr_title %}\
{{ commit.remote.pr_title | upper_first }}\
{% else %}\
{{ commit.message | split(pat="\n") | first | upper_first }}\
{% endif %}\
{% if commit.remote.pr_number %} ([#{{ commit.remote.pr_number }}](https://github.com/pyo3/maturin/pull/{{ commit.remote.pr_number }})){%- endif %}\
{% endfor %}\n
"""

[git]
conventional_commits = false
filter_unconventional = false
commit_parsers = [
{ field = "github.pr_labels", pattern = "internal", skip = true },
{ field = "github.pr_labels", pattern = "dependencies", skip = true },
{ message = ".*pre-commit autoupdate.*", skip = true },
{ message = ".*", group = "Other" },
]

[remote.github]
owner = "pyo3"
repo = "maturin"
20 changes: 20 additions & 0 deletions guide/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,23 @@ There are some optional hacks that can speed up the tests (over 80s to 17s on my
1. By running `cargo build --release --manifest-path test-crates/cargo-mock/Cargo.toml` you can activate a cargo cache avoiding to rebuild the pyo3 test crates with every python version.
2. Delete `target/test-cache` to clear the cache (e.g. after changing a test crate) or remove `test-crates/cargo-mock/target/release/cargo` to deactivate it.
3. By running the tests with the `faster-tests` feature, binaries are stripped and wheels are only stored and not compressed.

## Releasing

_These instructions are a work in progress_

Update the changelog:

```
git cliff -u --prepend Changelog.md --github-token <token>
```

Update the version in `Cargo.toml` and run:

```
cargo check
```

Create a PR a release PR.

After the release PR merged, update main, create a git tag and push the tag.
Loading