Skip to content
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.

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

Add MSRV 1.75 workflow check #981

Merged
merged 2 commits into from
Jul 9, 2024
Merged
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
37 changes: 37 additions & 0 deletions .github/workflows/rust-msrv.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev

name: MSRV 1.75 Check

jobs:

build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
rust:
- 1.75.0 # MSRV

steps:
- uses: actions/checkout@v2
- uses: Swatinem/[email protected]
- uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.rust }}
override: true
- name: Build Benches
run: cargo build --manifest-path=benches/Cargo.toml
- name: Build Protocols
run: cargo build --manifest-path=protocols/Cargo.toml
- name: Build Roles
run: cargo build --manifest-path=roles/Cargo.toml
- name: Build Utils
run: cargo build --manifest-path=utils/Cargo.toml
1 change: 0 additions & 1 deletion protocols/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name = "stratum_v2_protocols"
version = "1.0.0"
authors = ["The Stratum v2 Developers"]
edition = "2021"
rust-version = "1.75.0"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I get the point of CI, but why is it desirable to remove it from the different Cargo.toml files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It does version pinning locally across the rust toolchain, that can affect some local text editors that are configured for example to use only stable or other version. As the CI will cover any new code that does not pass MSRV, this version pinning becomes redundant and annoying for some :D

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, that has happened to me as well; my code editor continuously updates the Cargo.lock file because of this pinning. It would be nice to remove this pinning.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps we keep the removal of the rust-version lines in the Cargo.tomls and keep the removal of the rust-toolchain.toml, but then we clearly document in the README.md or the CONTRIBUTING guide that the MSRV is 1.75.0 and we add a pre-commit hook to the .githooks/pre-push to run this workflow locally before pushing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the README.md already mention the MSRV, not sure about the hooks tbh as it seems its not widely used

description = "The Stratum protocol defines how miners, proxies, and pools communicate to contribute hashrate to the Bitcoin network. Stratum v2 is a robust set of primitives which anyone can use to expand the protocol or implement a role."
documentation = "https://github.com/stratum-mining/stratum"
readme = "README.md"
Expand Down
1 change: 0 additions & 1 deletion roles/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name = "stratum_v2_roles"
version = "0.1.0"
authors = ["The Stratum v2 Developers"]
edition = "2021"
rust-version = "1.75.0"
description = "The Stratum protocol defines how miners, proxies, and pools communicate to contribute hashrate to the Bitcoin network. Stratum v2 is a robust set of primitives which anyone can use to expand the protocol or implement a role."
documentation = "https://github.com/stratum-mining/stratum"
readme = "README.md"
Expand Down
4 changes: 0 additions & 4 deletions rust-toolchain.toml

This file was deleted.

1 change: 0 additions & 1 deletion utils/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name = "stratum_v2_utils"
version = "1.0.0"
authors = ["The Stratum v2 Developers"]
edition = "2021"
rust-version = "1.75.0"
description = "The Stratum protocol defines how miners, proxies, and pools communicate to contribute hashrate to the Bitcoin network. Stratum v2 is a robust set of primitives which anyone can use to expand the protocol or implement a role."
documentation = "https://github.com/stratum-mining/stratum"
readme = "README.md"
Expand Down
Loading