Skip to content

ci: automate workspace releases with release-plz #2448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
notmandatory wants to merge 5 commits into
base: master
Choose a base branch
from
Open

ci: automate workspace releases with release-plz #2448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dffa080
build: configure release-plz for workspace crates
notmandatory Oct 29, 2026
4ff8c07
ci: add release-plz workflow
notmandatory Oct 29, 2026
6fe84f3
ci: bump setup-rust-toolchain action to v2
notmandatory Oct 29, 2026
be33975
docs: update release process for release-plz
notmandatory Oct 29, 2026
541c15b
ci: for setup-rust-toolchain@v2 action add rustflags '-D warnings'
notmandatory Nov 11, 2026
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
99 changes: 0 additions & 99 deletions .github/ISSUE_TEMPLATE/minor_release.md
View file
Open in desktop

This file was deleted.

71 changes: 0 additions & 71 deletions .github/ISSUE_TEMPLATE/patch_release.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->

### Changelog notice

<!-- Notice the release manager should include in the release tag message changelog -->
<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->

Comment on lines -12 to -16

@oleonardolima oleonardolima Nov 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should keep this in the PR template, so the author fill it with proper changes from their PRs

@notmandatory notmandatory Nov 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also rather use the PR review to enforce good commit messages instead of using this section of the PR which often needs to be re-worded by the release team anyway. I'm hoping once everyone gets in the habit of using commit messages for the changelog the release process will require much less manual work.

@notmandatory notmandatory Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also created an LLM skill that I'll post somewhere in the .github repo that does a good job of cleaning up the repo CHANGELOGs.

### Checklists

#### All Submissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/code_coverage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Install lcov tools
run: sudo apt-get install lcov -y
- name: Install Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: nightly-2025-11-27
components: llvm-tools-preview
Expand Down
38 changes: 25 additions & 13 deletions .github/workflows/cont_integration.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
Comment thread
notmandatory marked this conversation as resolved.
Resolved
with:
toolchain: 1.85.0 # MSRV
cache: true
rustflags: "-D warnings"
- name: Pin dependencies for MSRV
run: ./ci/pin-msrv.sh
- name: Build 1.85.0 (no default features)
Expand All @@ -50,10 +51,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (no default features)
Expand All @@ -77,10 +79,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (no default features)
Expand Down Expand Up @@ -108,10 +111,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (no default features)
Expand All @@ -135,10 +139,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (use-rustls)
Expand All @@ -164,10 +169,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (no default features)
Expand Down Expand Up @@ -199,10 +205,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Test (all features)
Expand All @@ -220,10 +227,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Build (default features)
run: cargo build
- name: Build (no default features)
Expand Down Expand Up @@ -252,11 +260,12 @@ jobs:
- run: sudo apt-get update || exit 1
- run: sudo apt-get install -y libclang-common-14-dev clang-14 libc6-dev-i386 || exit 1
- name: Install Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
target: "wasm32-unknown-unknown"
rustflags: "-D warnings"
- name: Check esplora
working-directory: ./crates/esplora
run: cargo check --target wasm32-unknown-unknown --no-default-features --features bdk_core/hashbrown,async
Expand All @@ -270,10 +279,11 @@ jobs:
uses: actions/checkout@v7
with:
persist-credentials: false
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
# TODO: `--target thumbv6m-none-eabi` should work but currently does not
# target: thumbv6m-none-eabi
- name: Check bdk_core (no-std, hashbrown)
Expand All @@ -292,7 +302,7 @@ jobs:
with:
persist-credentials: false
- name: Install Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: nightly
cache: true
Expand All @@ -311,11 +321,12 @@ jobs:
with:
persist-credentials: false
- name: Install Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
components: clippy
rustflags: "-D warnings"
- name: Check clippy
run: cargo clippy --all-features --all-targets -- -D warnings

Expand All @@ -329,9 +340,10 @@ jobs:
with:
persist-credentials: false
- name: Install Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
uses: actions-rust-lang/setup-rust-toolchain@v2
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
cache: true
rustflags: "-D warnings"
- name: Check docs
run: RUSTDOCFLAGS='-D warnings' cargo doc --workspace --all-features --no-deps
Loading
Loading