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 Breaking Change for macOS Entitlement Requirement #1707

Conversation

vicajilau
Copy link
Contributor

Pull Request: Add Breaking Change for macOS Entitlement Requirement

Description

This pull request introduces a breaking change for macOS users of the flutter_file_picker package.

Breaking Change

Starting from version 8.3.0, the pickFiles() method now requires the entitlement com.apple.security.files.user-selected.read-only on macOS. If this entitlement is not present, the method will return null and the file picker will not open, potentially leading to confusion among developers upgrading from previous versions where this entitlement was not required.

Justification

  • This change was introduced silently in version 8.3.0 without clear documentation, which can cause issues for developers who may not be aware of the requirement.
  • To ensure a smooth transition and proper functionality of the file picker on macOS, it is crucial to document this change as breaking in the changelog and update the API documentation accordingly.

Changes Made

  • Updated the CHANGELOG.md to include the breaking change notice.
  • Recommended that users add the entitlement to both DebugProfile.entitlements and Release.entitlements to restore the expected functionality.

Related Issue

Additional Notes

  • Future updates should include a warning or error message when the entitlement is missing to improve user experience.

CHANGELOG.md Outdated
@@ -22,6 +22,8 @@
## 8.3.0
### Desktop (macOS) && iOS
- Adds support for Swift Package Manager for compatibility with new projects [#1582](https://github.com/miguelpruivo/flutter_file_picker/issues/1582)
### macOS
Copy link
Collaborator

Choose a reason for hiding this comment

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

This was added on the Wiki: https://github.com/miguelpruivo/flutter_file_picker/wiki/Setup#macos

Maybe add a See also: https://github.com/miguelpruivo/flutter_file_picker/wiki/Setup#macos instead of pointing to the linked PR ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense! I didn't see it. On its way

Copy link
Collaborator

Choose a reason for hiding this comment

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

@vicajilau Apologies, but due to the other change that just landed, this is now in the wrong place.

Can you put it at the bottom of

## 8.2.0
### Desktop (macOS)
- Reimplement macOS file picker using method channels ...

Copy link
Contributor Author

@vicajilau vicajilau Feb 14, 2025

Choose a reason for hiding this comment

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

@navaronbracke Fixed 💪

@vicajilau
Copy link
Contributor Author

Resolved @navaronbracke 🚀

CHANGELOG.md Outdated
@@ -22,6 +22,8 @@
## 8.3.0
### Desktop (macOS) && iOS
- Adds support for Swift Package Manager for compatibility with new projects [#1582](https://github.com/miguelpruivo/flutter_file_picker/issues/1582)
### macOS
Copy link
Collaborator

Choose a reason for hiding this comment

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

@vicajilau Apologies, but due to the other change that just landed, this is now in the wrong place.

Can you put it at the bottom of

## 8.2.0
### Desktop (macOS)
- Reimplement macOS file picker using method channels ...

@navaronbracke
Copy link
Collaborator

@vicajilau I adjusted the changelog note a little, so that it is in bold in the markdown

@navaronbracke navaronbracke merged commit 5bd8395 into miguelpruivo:master Feb 14, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants