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 a NIOFileSystem shim #2689

Merged
merged 1 commit into from
Mar 22, 2024
Merged

Add a NIOFileSystem shim #2689

merged 1 commit into from
Mar 22, 2024

Conversation

glbrntt
Copy link
Contributor

@glbrntt glbrntt commented Mar 22, 2024

Motivation:

Renaming the NIOFileSystem module to _NIOFileSystem is a breaking change (which is okay, it's documented to be unstable API). However, users will be presented with a wall of build errors on updating to the next version of NIO. We can make the transition slightly easier for them.

Modifications:

Add back a NIOFileSystem module which re-exports _NIOFileSystem and add it as a target to the _NIOFileSystem product. This makes both modules available to users. We can then remove NIOFileSystem after a grace period.

Result:

Users can still build using NIOFileSystem while transitioning to _NIOFileSystem.

Motivation:

Renaming the `NIOFileSystem` module to `_NIOFileSystem` is a breaking
change (which is okay, it's documented to be unstable API). However,
users will be presented with a wall of build errors on updating to the
next version of NIO. We can make the transition slightly easier for
them.

Modifications:

Add back a `NIOFileSystem` module which re-exports `_NIOFileSystem` and
add it as a target to the `_NIOFileSystem` product. This makes both
modules available to users. We can then remove `NIOFileSystem` after a
grace period.

Result:

Users can still build using `NIOFileSystem` but can transition to
`_NIOFileSystem`.
@glbrntt glbrntt added the 🔼 needs-minor-version-bump For PRs that when merged cause a bump of the minor version, ie. 1.x.0 -> 1.(x+1).0 label Mar 22, 2024
@glbrntt glbrntt enabled auto-merge (squash) March 22, 2024 14:01
@glbrntt glbrntt merged commit 778e3da into apple:main Mar 22, 2024
8 of 9 checks passed
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===https://

Copy link
Member

Choose a reason for hiding this comment

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

can we add a #warning(...) here?

Copy link
Member

Choose a reason for hiding this comment

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

ah no sorry, that won't work

@glbrntt glbrntt deleted the re-export-niofs branch April 5, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔼 needs-minor-version-bump For PRs that when merged cause a bump of the minor version, ie. 1.x.0 -> 1.(x+1).0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants