Skip to content

Commit 7c28e01

Browse files
PyDataBlogPyDataBlog
authored
feat(release): Initial exploration of an automated release management system (#25)
* chore(templates): updated PR template * feat(release): Initial attempt to automate release management with git-cliff and cargo-release --------- Co-authored-by: PyDataBlog <PyDataBlog@users.noreply.github.com>
1 parent f08bd21 commit 7c28e01

File tree

8 files changed

+3897
-285
lines changed

8 files changed

+3897
-285
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Pull Request
33
about: Propose a change to the project
4-
title: ''
4+
title: 'feat(scope): describe your change'
55
labels: ''
66
assignees: ''
77

@@ -15,19 +15,21 @@ Please include a summary of the change and which issue is fixed. Please also inc
1515

1616
**Type of change**
1717

18-
Please choose the type of change that best describes your PR.
18+
Please update the title of your PR to match the type of change. The title will be used for the commit message and the changelog.
1919

20-
- [ ] `fix(scope)`: A bug fix (non-breaking change which fixes an issue)
21-
- [ ] `feat(scope)`: A new feature (non-breaking change which adds functionality)
22-
- [ ] `feat!(scope)`: A breaking change (fix or feature that would cause existing functionality to not work as expected)
23-
- [ ] `docs(scope)`: This change requires a documentation update
24-
- [ ] `chore(scope)`: Other changes that don't modify src or test files
25-
- [ ] `refactor(scope)`: A code change that neither fixes a bug nor adds a feature
26-
- [ ] `perf(scope)`: A code change that improves performance
27-
- [ ] `test(scope)`: Adding missing tests or correcting existing tests
28-
- [ ] `style(scope)`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
29-
- [ ] `ci(scope)`: Changes to our CI configuration files and scripts
30-
- [ ] `revert(scope)`: Reverts a previous commit
20+
The `(scope)` is optional and refers to the part of the codebase you're changing (e.g., `feat(search)`, `fix(ci)`).
21+
22+
- [ ] `fix`: A bug fix
23+
- [ ] `feat`: A new feature
24+
- [ ] `feat!`: A breaking change
25+
- [ ] `docs`: Documentation only changes
26+
- [ ] `chore`: Changes to the build process or auxiliary tools
27+
- [ ] `refactor`: A code change that neither fixes a bug nor adds a feature
28+
- [ ] `perf`: A code change that improves performance
29+
- [ ] `test`: Adding missing tests or correcting existing tests
30+
- [ ] `style`: Changes that do not affect the meaning of the code
31+
- [ ] `ci`: Changes to our CI configuration files and scripts
32+
- [ ] `revert`: Reverts a previous commit
3133

3234
**How Has This Been Tested?**
3335

@@ -42,8 +44,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
4244
- [ ] I have performed a self-review of my own code
4345
- [ ] I have commented my code, particularly in hard-to-understand areas
4446
- [ ] I have made corresponding changes to the documentation
45-
- [ ] I have added an entry to the CHANGELOG.md file
4647
- [ ] My changes generate no new warnings
4748
- [ ] I have added tests that prove my fix is effective or that my feature works
4849
- [ ] New and existing unit tests pass locally with my changes
49-
- [ ] Any dependent changes have been merged and published in downstream modules
50+
- [ ] Any dependent changes have been merged and published in downstream modules

‎.github/workflows/CI.yml‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -219,17 +219,6 @@ jobs:
219219
- name: Install Rust toolchain
220220
uses: dtolnay/rust-toolchain@stable
221221

222-
- name: Verify tag version matches Cargo.toml version
223-
run: |
224-
CARGO_VERSION=$(grep '^version =' Cargo.toml | cut -d '"' -f2)
225-
TAG_VERSION=${GITHUB_REF#refs/tags/v}
226-
echo "CARGO_VERSION: $CARGO_VERSION"
227-
echo "TAG_VERSION: $TAG_VERSION"
228-
if [ "$CARGO_VERSION" != "$TAG_VERSION" ]; then
229-
echo "Error: Git tag $TAG_VERSION doesn't match Cargo.toml version $CARGO_VERSION"
230-
exit 1
231-
fi
232-
233222
- name: Check package
234223
run: cargo package
235224

‎BENCHMARKS.md‎

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -5,77 +5,77 @@ This file is automatically generated by the CI. Do not edit manually.
55
### Insert Benchmark
66
| language | backend | ngram_size | mean | stddev | iterations |
77
|:-----------|:---------------|-------------:|---------:|----------:|-------------:|
8-
| julia | SimString.jl | 2 | 77.7038 | 20.3875 | 100 |
9-
| julia | SimString.jl | 3 | 89.007 | 21.4937 | 100 |
10-
| julia | SimString.jl | 4 | 105.621 | 27.9724 | 100 |
11-
| python | simstring-fast | 2 | 88.2363 | 2.82292 | 100 |
12-
| python | simstring-fast | 3 | 102.827 | 2.69786 | 100 |
13-
| python | simstring-fast | 4 | 111.771 | 2.96223 | 100 |
14-
| python | simstring-rs | 2 | 42.5572 | 0.472445 | 100 |
15-
| python | simstring-rs | 3 | 50.3763 | 0.887659 | 100 |
16-
| python | simstring-rs | 4 | 53.0267 | 1.20004 | 100 |
17-
| ruby | simstring-pure | 2 | 637.464 | 8.01842 | 32 |
18-
| ruby | simstring-pure | 3 | 704.137 | 5.88384 | 29 |
19-
| ruby | simstring-pure | 4 | 810.686 | 17.1456 | 25 |
20-
| rust | simstring-rs | 2 | 39.9313 | 0.830115 | 100 |
21-
| rust | simstring-rs | 3 | 46.6941 | 1.21243 | 100 |
22-
| rust | simstring-rs | 4 | 48.0926 | 0.676016 | 100 |
8+
| julia | SimString.jl | 2 | 78.2693 | 19.9496 | 100 |
9+
| julia | SimString.jl | 3 | 91.0927 | 21.3398 | 100 |
10+
| julia | SimString.jl | 4 | 107.629 | 28.1583 | 100 |
11+
| python | simstring-fast | 2 | 86.9242 | 2.29755 | 100 |
12+
| python | simstring-fast | 3 | 100.24 | 2.30679 | 100 |
13+
| python | simstring-fast | 4 | 109.862 | 2.73331 | 100 |
14+
| python | simstring-rs | 2 | 42.1472 | 0.45645 | 100 |
15+
| python | simstring-rs | 3 | 50.4065 | 1.93893 | 100 |
16+
| python | simstring-rs | 4 | 50.6396 | 1.1004 | 100 |
17+
| ruby | simstring-pure | 2 | 626.497 | 6.982 | 32 |
18+
| ruby | simstring-pure | 3 | 681.311 | 5.52234 | 30 |
19+
| ruby | simstring-pure | 4 | 773.841 | 14.2532 | 26 |
20+
| rust | simstring-rs | 2 | 39.7691 | 0.683471 | 100 |
21+
| rust | simstring-rs | 3 | 45.0449 | 1.16692 | 100 |
22+
| rust | simstring-rs | 4 | 46.5658 | 1.08378 | 100 |
2323

2424
### Search Benchmark
2525
| language | backend | ngram_size | threshold | mean | stddev | iterations |
2626
|:-----------|:------------------------|-------------:|------------:|----------:|----------:|-------------:|
27-
| julia | SimString.jl | 2 | 0.6 | 347.615 | 4.17335 | 58 |
28-
| julia | SimString.jl | 2 | 0.7 | 219.789 | 3.03473 | 91 |
29-
| julia | SimString.jl | 2 | 0.8 | 121.354 | 2.01378 | 100 |
30-
| julia | SimString.jl | 3 | 0.6 | 283.223 | 3.35626 | 71 |
31-
| julia | SimString.jl | 3 | 0.7 | 187.123 | 3.35245 | 100 |
32-
| julia | SimString.jl | 3 | 0.8 | 110.438 | 2.81422 | 100 |
33-
| julia | SimString.jl | 4 | 0.6 | 262.563 | 4.37634 | 77 |
34-
| julia | SimString.jl | 4 | 0.7 | 178.368 | 2.90331 | 100 |
35-
| julia | SimString.jl | 4 | 0.8 | 106.401 | 2.88828 | 100 |
36-
| python | simstring-fast | 2 | 0.6 | 105.181 | 2.47734 | 100 |
37-
| python | simstring-fast | 2 | 0.7 | 48.6483 | 1.5092 | 100 |
38-
| python | simstring-fast | 2 | 0.8 | 20.513 | 0.327448 | 100 |
39-
| python | simstring-fast | 2 | 0.9 | 8.83637 | 0.0541301 | 100 |
40-
| python | simstring-fast | 3 | 0.6 | 79.869 | 3.20468 | 100 |
41-
| python | simstring-fast | 3 | 0.7 | 35.8911 | 0.965854 | 100 |
42-
| python | simstring-fast | 3 | 0.8 | 17.1967 | 0.362276 | 100 |
43-
| python | simstring-fast | 3 | 0.9 | 8.87683 | 0.0437157 | 100 |
44-
| python | simstring-fast | 4 | 0.6 | 69.1906 | 3.70435 | 100 |
45-
| python | simstring-fast | 4 | 0.7 | 33.816 | 0.75335 | 100 |
46-
| python | simstring-fast | 4 | 0.8 | 16.7086 | 0.259309 | 100 |
47-
| python | simstring-fast | 4 | 0.9 | 9.285 | 0.117264 | 100 |
48-
| python | simstring-rust-bindings | 2 | 0.6 | 24.2423 | 1.44098 | 100 |
49-
| python | simstring-rust-bindings | 2 | 0.7 | 15.523 | 0.951135 | 100 |
50-
| python | simstring-rust-bindings | 2 | 0.8 | 9.46791 | 0.562107 | 100 |
51-
| python | simstring-rust-bindings | 2 | 0.9 | 5.80396 | 0.458168 | 100 |
52-
| python | simstring-rust-bindings | 3 | 0.6 | 23.0204 | 1.10629 | 100 |
53-
| python | simstring-rust-bindings | 3 | 0.7 | 15.9615 | 0.720662 | 100 |
54-
| python | simstring-rust-bindings | 3 | 0.8 | 10.4597 | 0.721537 | 100 |
55-
| python | simstring-rust-bindings | 3 | 0.9 | 6.41351 | 0.287381 | 100 |
56-
| python | simstring-rust-bindings | 4 | 0.6 | 23.8489 | 1.24589 | 100 |
57-
| python | simstring-rust-bindings | 4 | 0.7 | 17.6461 | 1.01696 | 100 |
58-
| python | simstring-rust-bindings | 4 | 0.8 | 11.5543 | 0.715451 | 100 |
59-
| python | simstring-rust-bindings | 4 | 0.9 | 6.88433 | 0.299745 | 100 |
60-
| ruby | simstring-pure | 2 | 0.6 | 784.243 | 5.72778 | 26 |
61-
| ruby | simstring-pure | 2 | 0.7 | 384.993 | 2.77205 | 52 |
62-
| ruby | simstring-pure | 2 | 0.8 | 177.979 | 1.70944 | 100 |
63-
| ruby | simstring-pure | 3 | 0.6 | 623.648 | 6.96877 | 33 |
64-
| ruby | simstring-pure | 3 | 0.7 | 309.405 | 3.72078 | 65 |
65-
| ruby | simstring-pure | 3 | 0.8 | 158.204 | 1.23255 | 100 |
66-
| ruby | simstring-pure | 4 | 0.6 | 564.024 | 4.08545 | 36 |
67-
| ruby | simstring-pure | 4 | 0.7 | 303.198 | 2.42227 | 66 |
68-
| ruby | simstring-pure | 4 | 0.8 | 162.519 | 1.60559 | 100 |
69-
| rust | simstring-rs | 2 | 0.6 | 26.1308 | 0.789262 | 100 |
70-
| rust | simstring-rs | 2 | 0.7 | 16.2025 | 0.613782 | 100 |
71-
| rust | simstring-rs | 2 | 0.8 | 9.10082 | 0.0741152 | 100 |
72-
| rust | simstring-rs | 2 | 0.9 | 4.88108 | 0.0461826 | 100 |
73-
| rust | simstring-rs | 3 | 0.6 | 25.5782 | 0.31648 | 100 |
74-
| rust | simstring-rs | 3 | 0.7 | 17.3256 | 0.329935 | 100 |
75-
| rust | simstring-rs | 3 | 0.8 | 10.2083 | 0.321997 | 100 |
76-
| rust | simstring-rs | 3 | 0.9 | 5.39696 | 0.064924 | 100 |
77-
| rust | simstring-rs | 4 | 0.6 | 26.4638 | 1.1248 | 100 |
78-
| rust | simstring-rs | 4 | 0.7 | 18.992 | 0.251991 | 100 |
79-
| rust | simstring-rs | 4 | 0.8 | 11.5117 | 0.115819 | 100 |
80-
| rust | simstring-rs | 4 | 0.9 | 6.06934 | 0.1302 | 100 |
27+
| julia | SimString.jl | 2 | 0.6 | 361.619 | 2.4945 | 56 |
28+
| julia | SimString.jl | 2 | 0.7 | 231.346 | 2.71282 | 87 |
29+
| julia | SimString.jl | 2 | 0.8 | 128.203 | 1.7987 | 100 |
30+
| julia | SimString.jl | 3 | 0.6 | 299.143 | 2.29399 | 67 |
31+
| julia | SimString.jl | 3 | 0.7 | 199.311 | 3.05715 | 100 |
32+
| julia | SimString.jl | 3 | 0.8 | 118.247 | 2.73945 | 100 |
33+
| julia | SimString.jl | 4 | 0.6 | 273.486 | 3.61805 | 74 |
34+
| julia | SimString.jl | 4 | 0.7 | 186.803 | 2.54764 | 100 |
35+
| julia | SimString.jl | 4 | 0.8 | 111.838 | 3.58856 | 100 |
36+
| python | simstring-fast | 2 | 0.6 | 102.092 | 2.2097 | 100 |
37+
| python | simstring-fast | 2 | 0.7 | 46.5107 | 0.426532 | 100 |
38+
| python | simstring-fast | 2 | 0.8 | 20.1711 | 0.215779 | 100 |
39+
| python | simstring-fast | 2 | 0.9 | 8.9566 | 0.674771 | 100 |
40+
| python | simstring-fast | 3 | 0.6 | 76.1475 | 3.19188 | 100 |
41+
| python | simstring-fast | 3 | 0.7 | 34.2489 | 0.499101 | 100 |
42+
| python | simstring-fast | 3 | 0.8 | 17.0319 | 0.146349 | 100 |
43+
| python | simstring-fast | 3 | 0.9 | 8.99279 | 0.083452 | 100 |
44+
| python | simstring-fast | 4 | 0.6 | 65.014 | 4.07225 | 100 |
45+
| python | simstring-fast | 4 | 0.7 | 31.8479 | 0.54327 | 100 |
46+
| python | simstring-fast | 4 | 0.8 | 16.6401 | 0.207086 | 100 |
47+
| python | simstring-fast | 4 | 0.9 | 9.29314 | 0.112283 | 100 |
48+
| python | simstring-rust-bindings | 2 | 0.6 | 23.4611 | 1.2495 | 100 |
49+
| python | simstring-rust-bindings | 2 | 0.7 | 15.2345 | 0.95689 | 100 |
50+
| python | simstring-rust-bindings | 2 | 0.8 | 9.30481 | 0.448355 | 100 |
51+
| python | simstring-rust-bindings | 2 | 0.9 | 5.61102 | 0.298837 | 100 |
52+
| python | simstring-rust-bindings | 3 | 0.6 | 22.9428 | 2.06327 | 100 |
53+
| python | simstring-rust-bindings | 3 | 0.7 | 16.0126 | 2.08571 | 100 |
54+
| python | simstring-rust-bindings | 3 | 0.8 | 10.6105 | 1.32166 | 100 |
55+
| python | simstring-rust-bindings | 3 | 0.9 | 6.54747 | 0.595053 | 100 |
56+
| python | simstring-rust-bindings | 4 | 0.6 | 24.3981 | 2.09672 | 100 |
57+
| python | simstring-rust-bindings | 4 | 0.7 | 18.073 | 1.46622 | 100 |
58+
| python | simstring-rust-bindings | 4 | 0.8 | 11.8883 | 1.18866 | 100 |
59+
| python | simstring-rust-bindings | 4 | 0.9 | 7.11635 | 0.654038 | 100 |
60+
| ruby | simstring-pure | 2 | 0.6 | 776.589 | 3.58635 | 26 |
61+
| ruby | simstring-pure | 2 | 0.7 | 381.448 | 2.71614 | 53 |
62+
| ruby | simstring-pure | 2 | 0.8 | 174.972 | 1.60447 | 100 |
63+
| ruby | simstring-pure | 3 | 0.6 | 615.409 | 5.55511 | 33 |
64+
| ruby | simstring-pure | 3 | 0.7 | 302.69 | 2.69876 | 67 |
65+
| ruby | simstring-pure | 3 | 0.8 | 155.339 | 1.19371 | 100 |
66+
| ruby | simstring-pure | 4 | 0.6 | 551.906 | 3.51965 | 37 |
67+
| ruby | simstring-pure | 4 | 0.7 | 297.958 | 1.72126 | 68 |
68+
| ruby | simstring-pure | 4 | 0.8 | 158.979 | 1.58777 | 100 |
69+
| rust | simstring-rs | 2 | 0.6 | 25.9153 | 1.02027 | 100 |
70+
| rust | simstring-rs | 2 | 0.7 | 16.0851 | 0.412726 | 100 |
71+
| rust | simstring-rs | 2 | 0.8 | 9.12094 | 0.0739038 | 100 |
72+
| rust | simstring-rs | 2 | 0.9 | 4.87109 | 0.113858 | 100 |
73+
| rust | simstring-rs | 3 | 0.6 | 25.2051 | 0.111566 | 100 |
74+
| rust | simstring-rs | 3 | 0.7 | 17.1372 | 0.0814332 | 100 |
75+
| rust | simstring-rs | 3 | 0.8 | 10.3011 | 0.219393 | 100 |
76+
| rust | simstring-rs | 3 | 0.9 | 5.51768 | 0.100236 | 100 |
77+
| rust | simstring-rs | 4 | 0.6 | 26.4028 | 0.399007 | 100 |
78+
| rust | simstring-rs | 4 | 0.7 | 19.1386 | 0.429459 | 100 |
79+
| rust | simstring-rs | 4 | 0.8 | 11.6934 | 0.176629 | 100 |
80+
| rust | simstring-rs | 4 | 0.9 | 6.16372 | 0.0963416 | 100 |
8181

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!--
2+
DO NOT EDIT THIS FILE MANUALLY.
3+
This file is automatically generated by git-cliff.
4+
-->
15
# simstring-rust
26

37
## v0.3.0

0 commit comments

Comments
 (0)