flutter/packages
1
0
Fork 0
mirror of https://github.com/flutter/packages.git synced 2025-06-08 04:18:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

[tool] version-check publish-check commands can check against pub (#3840)

Browse Source 
Add a PubVersionFinder class to easily fetch the version from pub.

Add an against-pub flag to check-version command, which allows it to check the version against pub server

Make the 'publish-check' command to check against pub to determine if the specific versions of packages need to be published.
Add a log-status flag, which allows the publish-check command to log the final status of the result. This helps other ci tools to easily grab the results and use it to determine what to do next. See option 3 in flutter/flutter#81444

This PR also fixes some tests.

partially flutter/flutter#81444
This commit is contained in:
Chris Yang
2021-05-11 12:48:30 -07:00
committed by GitHub
parent ce899a3151
commit 87cfd6ab03
8 changed files with 902 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
script/tool/lib/src/version_check_command.dart
View File

@ -6,6 +6,7 @@ import 'dart:async';
import 'package:file/file.dart';
import 'package:git/git.dart';
import 'package:http/http.dart' as http;
import 'package:meta/meta.dart';
import 'package:pub_semver/pub_semver.dart';
import 'package:pubspec_parse/pubspec_parse.dart';
@ -74,8 +75,21 @@ class VersionCheckCommand extends PluginCommand {
FileSystem fileSystem, {
ProcessRunner processRunner = const ProcessRunner(),
GitDir gitDir,
}) : super(packagesDir, fileSystem,
processRunner: processRunner, gitDir: gitDir);
this.httpClient,
}) : _pubVersionFinder =
PubVersionFinder(httpClient: httpClient ?? http.Client()),
super(packagesDir, fileSystem,
processRunner: processRunner, gitDir: gitDir) {
argParser.addFlag(
_againstPubFlag,
help: 'Whether the version check should run against the version on pub.\n'
'Defaults to false, which means the version check only run against the previous version in code.',
defaultsTo: false,
negatable: true,
);
}
static const String _againstPubFlag = 'against-pub';
@override
final String name = 'version-check';
@ -86,6 +100,11 @@ class VersionCheckCommand extends PluginCommand {
'Also checks if the latest version in CHANGELOG matches the version in pubspec.\n\n'
'This command requires "pub" and "flutter" to be in your path.';
/// The http client used to query pub server.
final http.Client httpClient;
final PubVersionFinder _pubVersionFinder;
@override
Future<void> run() async {
final GitVersionFinder gitVersionFinder = await retrieveVersionFinder();
@ -115,29 +134,61 @@ class VersionCheckCommand extends PluginCommand {
'intentionally has no version should be marked '
'"publish_to: none".');
}
final Version masterVersion =
await gitVersionFinder.getPackageVersion(pubspecPath);
if (masterVersion == null) {
print('${indentation}Unable to find pubspec in master. '
'Safe to ignore if the project is new.');
Version sourceVersion;
if (argResults[_againstPubFlag] as bool) {
final String packageName = pubspecFile.parent.basename;
final PubVersionFinderResponse pubVersionFinderResponse =
await _pubVersionFinder.getPackageVersion(package: packageName);
switch (pubVersionFinderResponse.result) {
case PubVersionFinderResult.success:
sourceVersion = pubVersionFinderResponse.versions.first;
print(
'$indentation$packageName: Current largest version on pub: $sourceVersion');
break;
case PubVersionFinderResult.fail:
printErrorAndExit(errorMessage: '''
${indentation}Error fetching version on pub for $packageName.
${indentation}HTTP Status ${pubVersionFinderResponse.httpResponse.statusCode}
${indentation}HTTP response: ${pubVersionFinderResponse.httpResponse.body}
''');
break;
case PubVersionFinderResult.noPackageFound:
sourceVersion = null;
break;
}
} else {
sourceVersion = await gitVersionFinder.getPackageVersion(pubspecPath);
}
if (sourceVersion == null) {
String safeToIgnoreMessage;
if (argResults[_againstPubFlag] as bool) {
safeToIgnoreMessage =
'${indentation}Unable to find package on pub server.';
} else {
safeToIgnoreMessage =
'${indentation}Unable to find pubspec in master.';
}
print('$safeToIgnoreMessage Safe to ignore if the project is new.');
continue;
}
if (masterVersion == headVersion) {
if (sourceVersion == headVersion) {
print('${indentation}No version change.');
continue;
}
final Map<Version, NextVersionType> allowedNextVersions =
getAllowedNextVersions(masterVersion, headVersion);
getAllowedNextVersions(sourceVersion, headVersion);
if (!allowedNextVersions.containsKey(headVersion)) {
final String source =
(argResults[_againstPubFlag] as bool) ? 'pub' : 'master';
final String error = '${indentation}Incorrectly updated version.\n'
'${indentation}HEAD: $headVersion, master: $masterVersion.\n'
'${indentation}HEAD: $headVersion, $source: $sourceVersion.\n'
'${indentation}Allowed versions: $allowedNextVersions';
printErrorAndExit(errorMessage: error);
} else {
print('$indentation$headVersion -> $masterVersion');
print('$indentation$headVersion -> $sourceVersion');
}
final bool isPlatformInterface =
@ -153,6 +204,7 @@ class VersionCheckCommand extends PluginCommand {
await for (final Directory plugin in getPlugins()) {
await _checkVersionsMatch(plugin);
}
_pubVersionFinder.httpClient.close();
print('No version check errors found!');
}
@ -224,7 +276,7 @@ The first version listed in CHANGELOG.md is $fromChangeLog.
printErrorAndExit(errorMessage: '''
When bumping the version for release, the NEXT section should be incorporated
into the new version's release notes.
''');
''');
}
}