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

Minor: Rephrase MSRV policy to be more explanatory #13668

Merged
merged 6 commits into from
Dec 6, 2024
Merged

Conversation

comphead
Copy link
Contributor

@comphead comphead commented Dec 5, 2024

Which issue does this PR close?

Looks like the MSRV policy on hotfixes can be slightly reworded and improved

Closes #.

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 5, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@findepi
Copy link
Member

findepi commented Dec 5, 2024

What about slightly different approach to the wording:

## Rust Version Compatibility Policy

The Rust toolchain releases are tracked at [Rust Versions](https://releases.rs) and follow
[semantic versioning](https://semver.org/). A Rust toolchain release can be identified
by a version string like `1.80.0`, or more generally `major.minor.patch`.
A Rust toolchain of given version can be officially released or in preparation,
as stated on the Rust Versions page.

DataFusion's Minimum Required Stable Rust Version (MSRV) policy is the following:

- the four latest stable Rust minor releases are supported.
  For example if the stable releases are `1.81.x`, `1.80.x`, `1.79.x`, `1.78.x`, `1.77.x`,
  then `1.81.x`, `1.80.x`, `1.79.x`, `1.78.x` are the four latest minor releases and are supported.
- the latest stable release as of four months ago is supported.
  For example if the current date is `2024-12-01`, then the latest stable release as of `2024-08-01`
  is supported.

Rust occasionally releases patch releases for a stable minor version.
Only the latest patch release for a stable minor version is supported.

We enforce this policy using a [MSRV CI Check](https://github.com/search?q=repo%3Aapache%2Fdatafusion+rust-version+language%3ATOML+path%3A%2F%5ECargo.toml%2F&type=code)

@comphead
Copy link
Contributor Author

comphead commented Dec 5, 2024

What about slightly different approach to the wording:

## Rust Version Compatibility Policy

The Rust toolchain releases are tracked at [Rust Versions](https://releases.rs) and follow
[semantic versioning](https://semver.org/). A Rust toolchain release can be identified
by a version string like `1.80.0`, or more generally `major.minor.patch`.
A Rust toolchain of given version can be officially released or in preparation,
as stated on the Rust Versions page.

DataFusion's Minimum Required Stable Rust Version (MSRV) policy is the following:

- the four latest stable Rust minor releases are supported.
  For example if the stable releases are `1.81.x`, `1.80.x`, `1.79.x`, `1.78.x`, `1.77.x`,
  then `1.81.x`, `1.80.x`, `1.79.x`, `1.78.x` are the four latest minor releases and are supported.
- the latest stable release as of four months ago is supported.
  For example if the current date is `2024-12-01`, then the latest stable release as of `2024-08-01`
  is supported.

Rust occasionally releases patch releases for a stable minor version.
Only the latest patch release for a stable minor version is supported.

We enforce this policy using a [MSRV CI Check](https://github.com/search?q=repo%3Aapache%2Fdatafusion+rust-version+language%3ATOML+path%3A%2F%5ECargo.toml%2F&type=code)

I like part about semver so its removes ambiguity about major and minor versions. For the policy itself I feel it can be easier to read... let me reword it

@comphead
Copy link
Contributor Author

comphead commented Dec 6, 2024

@alamb @findepi can I get the review on this?

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thanks @comphead - I think this PR is better than what is on main. I have a suggestion to perhaps make it clearer.

README.md Outdated Show resolved Hide resolved
comphead and others added 2 commits December 6, 2024 12:43
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
@comphead comphead merged commit 8404cd0 into apache:main Dec 6, 2024
4 checks passed
zhuliquan pushed a commit to zhuliquan/datafusion that referenced this pull request Dec 11, 2024
* Minor: Rephrase MSRV policy to be more explanatory

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* MSRV policy update

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
zhuliquan pushed a commit to zhuliquan/datafusion that referenced this pull request Dec 15, 2024
* Minor: Rephrase MSRV policy to be more explanatory

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* MSRV policy update

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants