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.

Sign up for GitHub

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

Jump to bottom

[flutter_markdown] Fix changelog regarding minimum supported SDK version #4851

Merged
merged 3 commits into from
Sep 12, 2023
Merged

[flutter_markdown] Fix changelog regarding minimum supported SDK version #4851

merged 3 commits into from
Sep 12, 2023

Conversation

nilsreichardt
Copy link
Contributor

The changelog of the flutter_markdown package is a bit confusing. First it says:

Updates minimum supported SDK version to Flutter 3.10/Dart 3.0

and in the latest update is says

Updates minimum supported SDK version to Flutter 3.7/Dart 2.19

Just from reading this I would expect that the minimum SDK lowered with the latest update. However, this is not the case.

After a bit of researching, I found this was caused by #4731. The mentioned PR only updates the minimum SDK of the example but not of the package, see: https://github.com/flutter/packages/pull/4731/files#diff-e780ee3aec5fdc10512b452b5464878a11caf22fb23d28f725324308ad243d17R6

Therefore, I clarified the changelog with this PR.

telegram-cloud-photo-size-2-5456132896298487892-y

image

Fixes flutter/flutter#134056

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@nilsreichardt
Copy link
Contributor Author

Not sure, if a change like this still needs a version change. If yes, I can bump the version in the pubspec.yaml and add a note in the changelog for changing the changelog.

@nilsreichardt nilsreichardt changed the title [flutter_markdown] fix changelog regarding minimum supported SDK version [flutter_markdown] Fix changelog regarding minimum supported SDK version Sep 5, 2023
@stuartmorgan
Copy link
Contributor

Not sure, if a change like this still needs a version change.

It depends whether we want the changelog to continue to be confusing on pub.dev until there happens to be some other change to the package or not. This is minor enough that I don't have a strong feeling either way.

@nilsreichardt
Copy link
Contributor Author

It depends whether we want the changelog to continue to be confusing on pub.dev until there happens to be some other change to the package or not. This is minor enough that I don't have a strong feeling either way.

If you don't mind, let's add this to the changelog so that we can publish a new version to update the changelog on pub.dev 👍

Should I just take the following sentences as change note? Feel free to suggest a different one.

Fixes a change note in the CHANGELOG.md

@stuartmorgan
Copy link
Contributor

CHANGELOG entries should be specific about what they are fixing, otherwise they don't convey much information to the reader:

Fixes an incorrect note about SDK versions in the 0.6.17+2 CHANGLOG.md entry.

@nilsreichardt
Copy link
Contributor Author

Thanks, I updated the version and the changelog.

stuartmorgan
stuartmorgan approved these changes Sep 12, 2023
View reviewed changes
Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@stuartmorgan stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 12, 2023
@auto-submit auto-submit bot merged commit c9fbe4e into flutter:main Sep 12, 2023
70 checks passed
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Sep 12, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 12, 2023
@engine-flutter-autoroll
c9fbe4e [flutter_markdown] Fix changelog regarding minimum supported …
ca66d2b 
…SDK version (flutter/packages#4851)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Sep 12, 2023
@engine-flutter-autoroll
Roll Packages from ef0c65e to e04ba88 (5 revisions) (#134546)
f9aef4f 
flutter/packages@ef0c65e...e04ba88

2023-09-12 stuartmorgan@google.com [tool] Add a package inclusion filter (flutter/packages#4904)
2023-09-12 me@nils.re [flutter_markdown] Fix changelog regarding minimum supported SDK version (flutter/packages#4851)
2023-09-12 stuartmorgan@google.com [ios_platform_images] Add integration tests (flutter/packages#4899)
2023-09-12 robert@odrowaz.dev [image_picker] Copy exif tags in categories II and III (flutter/packages#4738)
2023-09-11 233583+mossmana@users.noreply.github.com [google_maps_flutter_android] Fix for testToggleInfoWindow persistently flaky  (flutter/packages#4768)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
sybrands-place pushed a commit to sybrands-place/packages that referenced this pull request Sep 14, 2023
Merge branch 'main' into webview_patchedv5
d830653 
* main: (83 commits)
  go_router_builder: support the latest pkg:analyzer (flutter#4921)
  Replace collection type lints with more general lint (flutter#4912)
  Roll Flutter from 219efce to 4e7a07a (30 revisions) (flutter#4910)
  [camerax] Implement `startVideoCapturing` and `onVideoRecordedEvent` (flutter#4815)
  [tool] Add a package inclusion filter (flutter#4904)
  [flutter_markdown] Fix changelog regarding minimum supported SDK version (flutter#4851)
  [ios_platform_images] Add integration tests (flutter#4899)
  [image_picker] Copy exif tags in categories II and III (flutter#4738)
  [google_maps_flutter_android] Fix for testToggleInfoWindow persistently flaky  (flutter#4768)
  Roll Flutter from 7c28e8e to 219efce (16 revisions) (flutter#4901)
  [url_launcher] migrating iOS tests from objc to swift (flutter#4758)
  Roll Flutter from da676f7 to 7c28e8e (20 revisions) (flutter#4879)
  Bump actions/upload-artifact from 3.1.2 to 3.1.3 (flutter#4863)
  Roll Flutter from aea4552 to da676f7 (28 revisions) (flutter#4874)
  [webview_flutter_android] Added the functionality to fullscreen html5 video (flutter#3879)
  [tool] Add Android dependency (gradle) option to update dependencies command (flutter#4757)
  [camerax] Implement resolution configuration (flutter#3799)
  Manual roll Flutter from 685ce14 to aea4552 (64 revisions) (flutter#4870)
  [rfw, ci] Regenerate goldens, manually roll flutter#4835 (flutter#4862)
  Bump actions/checkout from 3.6.0 to 4.0.0 (flutter#4845)
  ...
@reidbaker reidbaker mentioned this pull request Sep 15, 2023
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartmorgan stuartmorgan stuartmorgan approved these changes

@domesticmouse domesticmouse domesticmouse approved these changes

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: flutter_markdown
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[flutter_markdown] Changelog is a bit confused regarding the minimum SDK
3 participants
@nilsreichardt @stuartmorgan @domesticmouse