Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
updated changelog and added comments
  • Loading branch information
jesswrd committed Oct 22, 2024
commit 30c2c33b337ec1ad7b6770b368eff18a3bf8fb49
1 change: 1 addition & 0 deletions packages/path_provider/path_provider/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## NEXT

* Updates example app Android compileSdkVersion to 35.
Copy link
Contributor

Choose a reason for hiding this comment

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

This changelog should also mention moving the example to include flutter as a declarative dependency.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Why are we updating the CHANGELOG at all for this PR? Example-build-only changes are exempt; we generally only mention them if they are about something that is directly relevant to clients of the package (e.g., if a new version of Android requires a new permission to use the code in the package, we might mention adding that permission to the example).

Copy link
Contributor

Choose a reason for hiding this comment

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

Because we are changing the example app which is users facing and should be updated.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's user-facing, but (other than the one file from the example directory shown on pub.dev) it's not directly pub-package-client-facing; if someone flutter pub upgrades and gets a new version of path_provider, nothing in this PR is in the code they will import, and that's generally what we consider as the CHANGELOG audience.

We expect people running the example to check out the repo (in theory they could build and run it directly from their pub cache, but they really shouldn't), and the git history is the record of changes for someone interacting with the repo itself.

The things in the CHANGELOG change here are part of what our written policy explicitly exempts, and we also have not historically put this kind of thing in the CHANGELOG, so it seems odd to include it this time.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, I misunderstood the policy. @jesswrd sorry for leading you astray but it will make your follow up prs much easier.

* Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.

## 2.1.4
Expand Down
6 changes: 4 additions & 2 deletions script/tool/lib/src/gradle_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,11 @@ buildscript {
apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"
''';

// GP stands for the gradle plugin method of flutter tooling inclusion.
/// String printed as a valid example of settings.gradle repository
/// configuration that enables artifact hub env variable.
/// GP stands for the gradle plugin method of flutter tooling inclusion.
@visibleForTesting
static String exampleRootSettingsArtifactHubStringGP = '''
static String exampleSettingsArtifactHubStringGP = '''
// See $artifactHubDocumentationString for more info.
pluginManagement {
def flutterSdkPath = {
Expand Down