Skip to content

[All] Expand artifact hub to all plugins #4645

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
Merged
merged 13 commits into from
Aug 7, 2023
Merged

[All] Expand artifact hub to all plugins #4645

merged 13 commits into from
Aug 7, 2023

Conversation

reidbaker
Copy link
Contributor

@reidbaker reidbaker commented Aug 4, 2023 •
edited
Loading

  • Adds artifact hub check to gradle command
  • Add tests for build.gradle and settings.gradle check
  • Update all example build.gradle and settings.gradle files

flutter/flutter/issues/120119

Expansion of #4567

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.

@reidbaker reidbaker marked this pull request as ready for review August 4, 2023 15:28
stuartmorgan-g
stuartmorgan-g approved these changes Aug 4, 2023
View reviewed changes
Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

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

LGTM with some minor comments. I'm looking forward to the reduced flake :)

script/tool/lib/src/gradle_check_command.dart Outdated
@@ -82,6 +88,10 @@ class GradleCheckCommand extends PackageLoopingCommand {
// Returns the gradle file in the given directory.
File _getBuildGradleFile(Directory dir) => dir.childFile('build.gradle');

// Returns the settings gradle file in the given directory.
File _getSettignsGradleFile(Directory dir) =>
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: Settings

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

script/tool/lib/src/gradle_check_command.dart Outdated
final RegExp keyPresentRegex =
RegExp("$keyVariable\\s+=\\s+'ARTIFACT_HUB_REPOSITORY'");
final RegExp documentationPresentRegex = RegExp(
r'github.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: github\.com

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I get lint warnings when I use \ as unnecessary values in a string. I opted for the looser regex instead of ignoring the lint.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe you need \\ even in a raw string then? I forget the rules around \ for raw strings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it is actually a false warning where dart assumes \ is used to escape and it is warning me that I dont need to escape .

... Except I do for regular expressions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://dart.dev/tools/linter-rules/unnecessary_string_escapes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

script/tool/lib/src/gradle_check_command.dart Outdated
final RegExp documentationPresentRegex = RegExp(
r'github.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
final RegExp keyReadRegex =
RegExp('if.*System.getenv.*containsKey.*$keyVariable');
Copy link
Contributor

Choose a reason for hiding this comment

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

Are the wildcards here just to avoid the readability hit of lots of \s?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes and I got lint warnings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the regex match a smaller set of inputs with \

script/tool/lib/src/gradle_check_command.dart Outdated
final RegExp documentationPresentRegex = RegExp(
r'github.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
final RegExp keyReadRegex =
RegExp('if.*System.getenv.*containsKey.*$keyVariable');
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: \.getenv

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

script/tool/lib/src/gradle_check_command.dart Outdated
final RegExp keyReadRegex =
RegExp('if.*System.getenv.*containsKey.*$keyVariable');
final RegExp keyUsedRegex =
RegExp('maven.*url.*System.getenv.*$keyVariable.*');
Copy link
Contributor

Choose a reason for hiding this comment

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

\.getenv

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

script/tool/lib/src/gradle_check_command.dart Outdated
gradleLines.any((String line) => keyUsedRegex.hasMatch(line));

if (!documentationPresent) {
printError('Does not link artifact hub documentation.');
Copy link
Contributor

Choose a reason for hiding this comment

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

This should print out the comment to add.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

After seeing this output run on packages missing artifact hub implementation I removed documentation as a separate printed error since it is included in the combined string.

script/tool/lib/src/gradle_check_command.dart Outdated
/// configuration that enables artifact hub env variable.
@visibleForTesting
static String exampleRootSettingsArtifactHubString = '''
// See https://github.com/flutter/flutter/wiki/Plugins-and-Packages-repository-structure#gradle-structure for more info.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's extract this URL to a constant that's used in both statics.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

script/tool/lib/src/gradle_check_command.dart Outdated
bool _validateArtifactHubSettingsUsage(
RepositoryPackage example, List<String> gradleLines) {
final RegExp documentationPresentRegex = RegExp(
r'github.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comments in these strings about escaping literal .s

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

script/tool/lib/src/gradle_check_command.dart Outdated
.any((String line) => artifactRegistryPluginApplyRegex.hasMatch(line));

if (!documentationPresent) {
printError('Does not link artifact hub documentation.');
Copy link
Contributor

Choose a reason for hiding this comment

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

As above, please include the link to add.

@reidbaker reidbaker added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 7, 2023
@auto-submit auto-submit bot merged commit 6cb2a32 into flutter:main Aug 7, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 8, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 8, 2023
@engine-flutter-autoroll
6cb2a32 [All] Expand artifact hub to all plugins (flutter/packages#4645)
8c7c9b7
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 8, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 8, 2023
@engine-flutter-autoroll
6cb2a32 [All] Expand artifact hub to all plugins (flutter/packages#4645)
35df659
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Aug 8, 2023
@engine-flutter-autoroll
Roll Packages from d7ee75a to ac41376 (8 revisions) (#132133)
3886b00 
flutter/packages@d7ee75a...ac41376

2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter from ad0aa8d to 436df69 (17 revisions) (flutter/packages#4663)
2023-08-08 10687576+bparrishMines@users.noreply.github.com [webview_flutter_wkwebview] Repeatedly pump WebViews until one is garbage collected (flutter/packages#4662)
2023-08-08 erikgerman917@gmail.com [xdg_directories] Add example app (flutter/packages#4554)
2023-08-08 70025277+Nitin-Poojary@users.noreply.github.com [pigeon] Recursively create output target files (flutter/packages#4458)
2023-08-07 jpnurmi@gmail.com [path_provider] Add getApplicationCachePath() (flutter/packages#4483)
2023-08-07 10687576+bparrishMines@users.noreply.github.com [flutter_markdown] Adopt code excerpts in README (flutter/packages#4656)
2023-08-07 reidbaker@google.com [All] Expand artifact hub to all plugins (flutter/packages#4645)
2023-08-07 engine-flutter-autoroll@skia.org Roll Flutter from 2ba9f7b to ad0aa8d (31 revisions) (flutter/packages#4659)

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
@reidbaker reidbaker mentioned this pull request Sep 13, 2023
Merged
8 tasks
@gmackall gmackall mentioned this pull request Oct 12, 2023
Closed
@camsim99 camsim99 mentioned this pull request May 30, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartmorgan-g stuartmorgan-g stuartmorgan-g approved these changes

@camsim99 camsim99 Awaiting requested review from camsim99 camsim99 is a code owner

@gmackall gmackall Awaiting requested review from gmackall gmackall is a code owner

@bparrishMines bparrishMines Awaiting requested review from bparrishMines bparrishMines is a code owner

@tarrinneal tarrinneal Awaiting requested review from tarrinneal tarrinneal is a code owner

@Hixie Hixie Awaiting requested review from Hixie Hixie is a code owner

@gspencergoog gspencergoog Awaiting requested review from gspencergoog

@chunhtai chunhtai Awaiting requested review from chunhtai chunhtai is a code owner

@domesticmouse domesticmouse Awaiting requested review from domesticmouse

@ditman ditman Awaiting requested review from ditman ditman is a code owner

@Piinks Piinks Awaiting requested review from Piinks

@goderbauer goderbauer Awaiting requested review from goderbauer

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App override: no changelog needed Override the check requiring CHANGELOG updates for most changes override: no versioning needed Override the check requiring version bumps for most changes p: animations p: camera p: dynamic_layouts The dynamic_layouts package p: espresso p: extension_google_sign_in_as_googleapis_auth p: file_selector p: flutter_adaptive_scaffold p: flutter_markdown p: flutter_plugin_android_lifecycle p: go_router p: google_maps_flutter p: google_sign_in p: image_picker p: in_app_purchase p: local_auth p: palette_generator p: path_provider p: pigeon p: quick_actions p: rfw Remote Flutter Widgets p: shared_preferences p: url_launcher p: video_player p: webview_flutter platform-android
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@reidbaker @stuartmorgan-g