feat: GitHub Action customizations

Author: Dillon Nys

mono_repo/lib/src/commands/github/github_yaml.dart

@@ -4,6 +4,8 @@
 
 import 'dart:collection';
 
+import 'package:path/path.dart';
+
 import '../../ci_shared.dart';
 import '../../github_config.dart';
 import '../../mono_config.dart';
@@ -308,15 +310,27 @@ extension on CIJobEntry {
         ),
       );
       for (var i = 0; i < commands.length; i++) {
+        final task = job.tasks[i];
+        var workingDirectory = task.action?.workingDirectory;
+        if (workingDirectory != null) {
+          workingDirectory = posix.normalize(
+            posix.join(package, workingDirectory),
+          );
+        }
         commandEntries.add(
           _CommandEntry(
-            '$package; ${job.tasks[i].command}',
-            _commandForOs(job.tasks[i].command),
-            type: job.tasks[i].type,
-            // Run this regardless of the success of other steps other than the
-            // pub step.
-            ifCondition: "always() && steps.$pubStepId.conclusion == 'success'",
-            workingDirectory: package,
+            '$package; ${task.command}',
+            _commandForOs(task.command),
+            type: task.type,
+            id: task.action?.id,
+            ifCondition: task.action?.condition ??
+                // Run this regardless of the success of other steps other than
+                // the pub step.
+                "always() && steps.$pubStepId.conclusion == 'success'",
+            workingDirectory: workingDirectory ?? package,
+            uses: task.action?.uses,
+            inputs: task.action?.inputs,
+            shell: task.action?.shell,
           ),
         );
       }
@@ -425,6 +439,10 @@ class _CommandEntry extends _CommandEntryBase {
   final String? id;
   final String? ifCondition;
   final String workingDirectory;
+  final String? uses;
+  final Map<String, String>? env;
+  final Map<String, Object>? inputs;
+  final String? shell;
 
   _CommandEntry(
     super.name,
@@ -433,17 +451,32 @@ class _CommandEntry extends _CommandEntryBase {
     this.type,
     this.id,
     this.ifCondition,
+    this.uses,
+    this.env,
+    this.inputs,
+    this.shell,
   });
 
   @override
   Iterable<Step> get runContent => [
-        Step.run(
-          id: id,
-          name: name,
-          ifContent: ifCondition,
-          workingDirectory: workingDirectory,
-          run: run,
-        ),
+        if (uses != null)
+          Step.uses(
+            id: id,
+            name: name,
+            uses: uses,
+            withContent: inputs,
+            ifContent: ifCondition,
+          )
+        else
+          Step.run(
+            id: id,
+            name: name,
+            ifContent: ifCondition,
+            workingDirectory: workingDirectory,
+            run: run,
+            env: env,
+            shell: shell,
+          ),
         ...?type?.afterEachSteps(workingDirectory),
       ];
 }

mono_repo/lib/src/commands/github/step.dart

@@ -29,6 +29,8 @@ class Step implements YamlLike {
   @JsonKey(name: 'with')
   final Map? withContent;
 
+  final String? shell;
+
   Step._({
     this.id,
     this.withContent,
@@ -38,6 +40,7 @@ class Step implements YamlLike {
     this.ifContent,
     this.workingDirectory,
     this.env,
+    this.shell,
   }) {
     if (run == null) {
       if (uses == null) {
@@ -71,6 +74,7 @@ class Step implements YamlLike {
     this.ifContent,
     this.workingDirectory,
     this.env,
+    this.shell,
   })  : uses = null,
         withContent = null;
 
@@ -82,7 +86,8 @@ class Step implements YamlLike {
     this.ifContent,
   })  : run = null,
         env = null,
-        workingDirectory = null;
+        workingDirectory = null,
+        shell = null;
 
   factory Step.fromJson(Map json) => _$StepFromJson(json);
 

mono_repo/lib/src/github_config.dart

@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:convert';
+
 import 'package:json_annotation/json_annotation.dart';
 
 import 'commands/github/job.dart';
@@ -141,6 +143,142 @@ class GitHubWorkflow {
   factory GitHubWorkflow.fromJson(Map json) => _$GitHubWorkflowFromJson(json);
 }
 
+/// Extra configuration for customizing the GitHub action context in which a
+/// task runs.
+class ActionConfig {
+  ActionConfig({
+    this.id,
+    this.uses,
+    this.condition,
+    this.inputs,
+    this.workingDirectory,
+    this.shell,
+  });
+
+  /// The step's identifier, which can be used to refer to the step and its
+  /// outputs in the [condition] property of this and other steps.
+  final String? id;
+
+  /// The GitHub action identifier, e.g. `actions/checkout@v3`.
+  final String? uses;
+
+  /// The inputs to the action.
+  ///
+  /// A map of key-value pairs which are passed to the action's `with`
+  /// parameter.
+  final Map<String, String>? inputs;
+
+  /// The condition on which to run this action.
+  final String? condition;
+
+  /// The directory in which to run this action.
+  final String? workingDirectory;
+
+  /// The shell override for this action.
+  final String? shell;
+
+  factory ActionConfig.fromJson(Map json) {
+    // Create a copy of unmodifiable `json`.
+    json = Map.of(json);
+
+    final Object? id = json.remove('id');
+    if (id is! String?) {
+      throw CheckedFromJsonException(
+        json,
+        'id',
+        'ActionConfig',
+        'Invalid `id` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsid',
+      );
+    }
+    final Object? uses = json.remove('uses');
+    if (uses is! String?) {
+      throw CheckedFromJsonException(
+        json,
+        'uses',
+        'ActionConfig',
+        'Invalid `uses` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses',
+      );
+    }
+    final Object? inputs = json.remove('with');
+    if (inputs is! Map?) {
+      throw CheckedFromJsonException(
+        json,
+        'with',
+        'ActionConfig',
+        'Invalid `with` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith',
+      );
+    }
+    // Transform <String, Object> -> <String, String> instead of throwing so
+    // that, for example, numerical values are properly converted.
+    final mappedInputs = inputs?.map(
+      (key, value) {
+        if (value is! String) {
+          value = jsonEncode(value);
+        }
+        return MapEntry(key as String, value);
+      },
+    );
+    final Object? condition = json.remove('if');
+    if (condition is! String?) {
+      throw CheckedFromJsonException(
+        json,
+        'if',
+        'ActionConfig',
+        'Invalid `if` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsif',
+      );
+    }
+    final Object? workingDirectory = json.remove('working-directory');
+    if (workingDirectory is! String?) {
+      throw CheckedFromJsonException(
+        json,
+        'working-directory',
+        'ActionConfig',
+        'Invalid `working-directory` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun',
+      );
+    }
+    final Object? shell = json.remove('shell');
+    if (shell is! String?) {
+      throw CheckedFromJsonException(
+        json,
+        'shell',
+        'ActionConfig',
+        'Invalid `shell` parameter. See GitHub docs for more info: '
+            'https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell',
+      );
+    }
+    if (json.isNotEmpty) {
+      throw CheckedFromJsonException(
+        json,
+        json.keys.join(','),
+        'ActionConfig',
+        'Invalid keys',
+      );
+    }
+    return ActionConfig(
+      id: id,
+      uses: uses,
+      inputs: mappedInputs,
+      condition: condition,
+      workingDirectory: workingDirectory,
+      shell: shell,
+    );
+  }
+
+  Map<String, Object> toJson() => {
+        if (id != null) 'id': id!,
+        if (uses != null) 'uses': uses!,
+        if (inputs != null) 'with': inputs!,
+        if (condition != null) 'if': condition!,
+        if (workingDirectory != null) 'working-directory': workingDirectory!,
+        if (shell != null) 'shell': shell!,
+      };
+}
+
 Map<String, dynamic> _parseOn(Map<String, dynamic>? on, String? cron) {
   if (on == null) {
     if (cron == null) {

mono_repo/lib/src/package_config.dart

@@ -9,6 +9,7 @@ import 'package:pub_semver/pub_semver.dart';
 import 'package:pubspec_parse/pubspec_parse.dart';
 import 'package:yaml/yaml.dart';
 
+import 'github_config.dart';
 import 'package_flavor.dart';
 import 'raw_config.dart';
 import 'task_type.dart';
@@ -307,7 +308,10 @@ class Task {
 
   final String command;
 
-  Task(this.flavor, this.type, {this.args})
+  /// The GitHub action context.
+  final ActionConfig? action;
+
+  Task(this.flavor, this.type, {this.args, this.action})
       : command = type.commandValue(flavor, args).join(' ');
 
   /// Parses an individual item under `stages`, which might be a `group` or an
@@ -395,8 +399,22 @@ class Task {
           args = yamlValue[taskName] as String?;
       }
 
+      final actionYaml = yamlValue['action'] as Object?;
+      if (actionYaml is! Map?) {
+        throw CheckedFromJsonException(
+          yamlValue,
+          'action',
+          'Task',
+          'Must be a map',
+        );
+      }
+      ActionConfig? action;
+      if (actionYaml != null) {
+        action = ActionConfig.fromJson(actionYaml);
+      }
+
       final extraConfig = Set<String>.from(yamlValue.keys)
-        ..removeAll([taskName, 'os', 'sdk']);
+        ..removeAll([taskName, 'os', 'sdk', 'action']);
 
       // TODO(kevmoo): at some point, support custom configuration here
       if (extraConfig.isNotEmpty) {
@@ -409,7 +427,7 @@ class Task {
         );
       }
       try {
-        return Task(flavor, taskType, args: args);
+        return Task(flavor, taskType, args: args, action: action);
       } on InvalidTaskConfigException catch (e) {
         throw CheckedFromJsonException(
           yamlValue,