Skip to content

Commit 1a163f9

Browse files
tvpetertvpeter
committed
feat(git-workflow): add issues template
1 parent ed39a3e commit 1a163f9

File tree

6 files changed

+181
-2
lines changed

6 files changed

+181
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**To Reproduce**
14+
<!-- Steps or code to reproduce the behavior. -->
15+
16+
**Expected behavior**
17+
<!-- A clear and concise description of what you expected to happen. -->
18+
19+
**Build environment**
20+
- BDK-RPC-CLIENT tag/commit: <!-- e.g. v0.13.0, 3a07614 -->
21+
- OS+version: <!-- e.g. ubuntu 20.04.01, macOS 12.0.1, windows -->
22+
- Rust/Cargo version: <!-- e.g. 1.56.0 -->
23+
- Rust/Cargo target: <!-- e.g. x86_64-apple-darwin, x86_64-unknown-linux-gnu, etc. -->
24+
25+
**Additional context**
26+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/enhancement_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Enhancement request
3+
about: Request a new feature or change to an existing feature
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the enhancement**
11+
<!-- A clear and concise description of what you would like added or changed. -->
12+
13+
**Use case**
14+
<!-- Tell us how you or others will use this new feature or change to an existing feature. -->
15+
16+
**Additional context**
17+
<!-- Add any other context about the enhancement here. -->

‎.github/ISSUE_TEMPLATE/minor_release.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Minor Release
3+
about: Create a new minor release [for release managers only]
4+
title: 'Release MAJOR.MINOR+1.0'
5+
labels: 'release'
6+
assignees: ''
7+
8+
---
9+
10+
## Create a new minor release
11+
12+
### Summary
13+
14+
<--release summary to be used in announcements-->
15+
16+
### Commit
17+
18+
<--latest commit ID to include in this release-->
19+
20+
### Changelog
21+
22+
<--add notices from PRs merged since the prior release, see ["keep a changelog"]-->
23+
24+
### Checklist
25+
26+
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
27+
branch **development** version is *MAJOR.MINOR.0*.
28+
29+
#### On the day of the feature freeze
30+
31+
Change the `master` branch to the next MINOR+1 version:
32+
33+
- [ ] Switch to the `master` branch.
34+
- [ ] Create a new PR branch called `bump_dev_MAJOR_MINOR+1`, eg. `bump_dev_0_22`.
35+
- [ ] Bump the `bump_dev_MAJOR_MINOR+1` branch to the next development MINOR+1 version.
36+
- Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0`.
37+
- The commit message should be "Bump version to MAJOR.MINOR+1.0".
38+
- [ ] Create PR and merge the `bump_dev_MAJOR_MINOR+1` branch to `master`.
39+
- Title PR "Bump version to MAJOR.MINOR+1.0".
40+
41+
#### On the day of the release
42+
43+
Tag and publish new release:
44+
45+
- [ ] Double check that your local `master` is up-to-date with the upstream repo.
46+
- [ ] Create a new branch called `release/MAJOR.MINOR+1` from `master`.
47+
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch.
48+
- The tag name should be `vMAJOR.MINOR+1.0`
49+
- The first line of the tag message should be "Release MAJOR.MINOR+1.0".
50+
- In the body of the tag message put a copy of the **Summary** and **Changelog** for the release.
51+
- Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
52+
- [ ] Wait for the CI to finish one last time.
53+
- [ ] Push the new tag to the `bitcoindevkit/bdk_rpc_client` repo.
54+
- [ ] Publish **all** the updated crates to crates.io.
55+
- [ ] Create the release on GitHub.
56+
- Go to "tags", click on the dots on the right and select "Create Release".
57+
- Set the title to `Release MAJOR.MINOR+1.0`.
58+
- In the release notes body put the **Summary** and **Changelog**.
59+
- Use the "+ Auto-generate release notes" button to add details from included PRs.
60+
- Until we reach a `1.0.0` release check the "Pre-release" box.
61+
- [ ] Make sure the new release shows up on [crates.io] and that the docs are built correctly on [docs.rs].
62+
- [ ] Announce the release, using the **Summary**, on Discord, Twitter and Mastodon.
63+
- [ ] Celebrate 🎉
64+
65+
[Semantic Versioning]: https://semver.org/
66+
[crates.io]: https://crates.io/crates/bdk_rpc_client
67+
[docs.rs]: https://docs.rs/bdk_rpc_client/latest/bdk_rpc_client
68+
["keep a changelog"]: https://keepachangelog.com/en/1.0.0/

‎.github/ISSUE_TEMPLATE/patch_release.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
name: Patch Release
3+
about: Create a new patch release [for release managers only]
4+
title: 'Release MAJOR.MINOR.PATCH+1'
5+
labels: 'release'
6+
assignees: ''
7+
8+
---
9+
10+
## Create a new patch release
11+
12+
### Summary
13+
14+
<--release summary to be used in announcements-->
15+
16+
### Commit
17+
18+
<--latest commit ID to include in this release-->
19+
20+
### Changelog
21+
22+
<--add notices from PRs merged since the prior release, see ["keep a changelog"]-->
23+
24+
### Checklist
25+
26+
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
27+
branch **development** version is *MAJOR.MINOR.PATCH*.
28+
29+
### On the day of the patch release
30+
31+
Change the `master` branch to the new PATCH+1 version:
32+
33+
- [ ] Switch to the `master` branch.
34+
- [ ] Create a new PR branch called `bump_dev_MAJOR_MINOR_PATCH+1`, eg. `bump_dev_0_22_1`.
35+
- [ ] Bump the `bump_dev_MAJOR_MINOR` branch to the next development PATCH+1 version.
36+
- Change the `Cargo.toml` version value to `MAJOR.MINOR.PATCH+1`.
37+
- The commit message should be "Bump version to MAJOR.MINOR.PATCH+1".
38+
- [ ] Create PR and merge the `bump_dev_MAJOR_MINOR_PATCH+1` branch to `master`.
39+
- Title PR "Bump version to MAJOR.MINOR.PATCH+1".
40+
41+
Cherry-pick, tag and publish new PATCH+1 release:
42+
43+
- [ ] Merge fix PRs to the `master` branch.
44+
- [ ] Git cherry-pick fix commits to the `release/MAJOR.MINOR` branch to be patched.
45+
- [ ] Verify fixes in `release/MAJOR.MINOR` branch.
46+
- [ ] Bump the `release/MAJOR.MINOR.PATCH+1` branch to `MAJOR.MINOR.PATCH+1` version.
47+
- Change the `Cargo.toml` version value to `MAJOR.MINOR.MINOR.PATCH+1`.
48+
- The commit message should be "Bump version to MAJOR.MINOR.PATCH+1".
49+
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR` branch.
50+
- The tag name should be `vMAJOR.MINOR.PATCH+1`
51+
- The first line of the tag message should be "Release MAJOR.MINOR.PATCH+1".
52+
- In the body of the tag message put a copy of the **Summary** and **Changelog** for the release.
53+
- Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
54+
- [ ] Wait for the CI to finish one last time.
55+
- [ ] Push the new tag to the `bitcoindevkit/bdk_rpc_client` repo.
56+
- [ ] Publish **all** the updated crates to crates.io.
57+
- [ ] Create the release on GitHub.
58+
- Go to "tags", click on the dots on the right and select "Create Release".
59+
- Set the title to `Release MAJOR.MINOR.PATCH+1`.
60+
- In the release notes body put the **Summary** and **Changelog**.
61+
- Use the "+ Auto-generate release notes" button to add details from included PRs.
62+
- Until we reach a `1.0.0` release check the "Pre-release" box.
63+
- [ ] Make sure the new release shows up on [crates.io] and that the docs are built correctly on [docs.rs].
64+
- [ ] Announce the release, using the **Summary**, on Discord, Twitter and Mastodon.
65+
- [ ] Celebrate 🎉
66+
67+
[Semantic Versioning]: https://semver.org/
68+
[crates.io]: https://crates.io/crates/bdk_rpc_client
69+
[docs.rs]: https://docs.rs/bdk_rpc_client/latest/bdk_rpc_client
70+
["keep a changelog"]: https://keepachangelog.com/en/1.0.0/

‎.github/workflows/cont_integration.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,6 @@ jobs:
140140
strategy:
141141
matrix:
142142
features:
143-
- --features default
144143
- --all-features
145144
steps:
146145
- uses: actions/checkout@v4

‎Cargo.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,4 @@ corepc-types = { version = "0.10.1", features = ["default"]}
88
jsonrpc = { version = "0.18.0", features = ["simple_http", "simple_tcp", "minreq_http", "simple_uds", "proxy"] }
99

1010
[features]
11-
default = [ "v30" ]
1211
v30 = [ ]

0 commit comments

Comments
 (0)