Introduce a health checking workflow

.github/workflows/health.yaml

@@ -0,0 +1,71 @@
+# A CI configuration to check PR health.
+
+name: Health
+
+# Callers of this workflow should use it as follows:
+#
+# name: Health
+# on:
+# pull_request:
+# branches: [ main ]
+# types: [opened, synchronize, reopened, labeled, unlabeled]
+# jobs:
+# health:
+# uses: dart-lang/ecosystem/.github/workflows/health.yaml@main
+
+# Callers may optionally specify the version of the SDK to use when publishing a
+# package. This can be useful if your package has a very recent minimum SDK
+# constraint. This is done via the `sdk` input parameter. Note that this
+# parameter is not required; it defaults to `stable` - using the most recent
+# stable release of the Dart SDK.
+# The checks can also be restricted to any subset of version, changelog, and license,
+# if needed.
+#
+# jobs:
+# health:
+# uses: dart-lang/ecosystem/.github/workflows/health.yaml@main
+# with:
+# sdk: beta
+# checks: "version,changelog,license"
+
+on:
+ workflow_call:
+ inputs:
+ sdk:
+ description: >-
+ The channel, or a specific version from a channel, to install
+ ('2.19.0','stable', 'beta', 'dev'). Using one of the three channels
+ will give you the latest version published to that channel.
+ default: "stable"
+ required: false
+ type: string
+ checks:
+ description: What to check for in the PR health check - any subset of "version,changelog,license"
+ default: "version,changelog,license"
+ type: string
+ required: false
+
+jobs:
+ health:
+ # These permissions are required for authentication using OIDC and to enable
+ # us to create comments on PRs.
+ permissions:
+ pull-requests: write
+
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
+ - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
+ with:
+ sdk: ${{ inputs.sdk }}
+
+ - name: Install firehose
+ run: dart pub global activate --source git https://github.com/dart-lang/ecosystem.git --git-path pkgs/firehose/ --git-ref=unifiedWorkflow #TODO remove, just for testing
+
+ - name: Validate packages
+ if: ${{ github.event_name == 'pull_request' }}
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ ISSUE_NUMBER: ${{ github.event.number }}
+ PR_LABELS: "${{ join(github.event.pull_request.labels.*.name) }}"
+ run: dart pub global run firehose --health ${{ inputs.checks }}

.github/workflows/health_internal.yaml

@@ -0,0 +1,12 @@
+# A CI configuration to check PR health.
+
+name: Health
+on:
+ pull_request:
+ branches: [ main ]
+ types: [opened, synchronize, reopened, labeled, unlabeled]
+jobs:
+ health:
+ uses: ./.github/workflows/health.yaml
+ with:
+ checks: "changelog,license"

pkgs/firehose/bin/firehose.dart

@@ -20,10 +20,11 @@ void main(List<String> arguments) async {
 
  var validate = argResults['validate'] == true;
  var publish = argResults['publish'] == true;
+ var health = argResults['health'] != null;
 
- if (!validate && !publish) {
- _usage(argParser,
- error: 'Error: one of --validate or --publish must be specified.');
+ if (!validate && !publish && !health) {
+ _usage(argParser, error: '''
+Error: one of --validate, --publish, or --health must be specified.''');
  exit(1);
  }
 
@@ -41,6 +42,8 @@ void main(List<String> arguments) async {
  await firehose.validate();
  } else if (publish) {
  await firehose.publish();
+ } else if (health) {
+ await firehose.healthCheck(argResults['health'] as List);
  }
  } on ArgParserException catch (e) {
  _usage(argParser, error: e.message);
@@ -73,6 +76,11 @@ ArgParser _createArgs() {
  help: 'Validate packages and indicate whether --publish would publish '
  'anything.',
  )
+ ..addMultiOption(
+ 'health',
+ defaultsTo: ['version', 'license', 'changelog'],
+ help: 'Check PR health.',
+ )
  ..addFlag(
  'publish',
  negatable: false,