Migrate to top-level action

Author: Dillon Nys

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

@@ -17,6 +17,7 @@ import '../../user_exception.dart';
 import '../../yaml.dart';
 import 'action_info.dart';
 import 'job.dart';
+import 'overrides.dart';
 import 'step.dart';
 
 const _onCompletionStage = '_on_completion';
@@ -305,36 +306,40 @@ extension on CIJobEntry {
           id: pubStepId,
           // Run this regardless of the success of other steps other than the
           // pub step.
-          ifCondition: "always() && steps.checkout.conclusion == 'success'",
+          ifContent: "always() && steps.checkout.conclusion == 'success'",
           workingDirectory: package,
         ),
       );
       for (var i = 0; i < commands.length; i++) {
         final task = job.tasks[i];
-        var workingDirectory = task.action?.workingDirectory;
+        final overrides = task.type.overrides;
+        var workingDirectory = overrides?.workingDirectory;
         if (workingDirectory != null) {
           workingDirectory = posix.normalize(
             posix.join(package, workingDirectory),
           );
         }
-        var condition = task.action?.condition;
-        if (condition != null) {
-          condition += " && steps.$pubStepId.conclusion == 'success'";
+        var ifCondition = overrides?.ifContent;
+        if (ifCondition != null) {
+          ifCondition += " && steps.$pubStepId.conclusion == 'success'";
         }
         commandEntries.add(
           _CommandEntry(
             '$package; ${task.command}',
             _commandForOs(task.command),
             type: task.type,
-            id: task.action?.id,
-            ifCondition: condition ??
+            id: overrides?.id,
+            ifContent: ifCondition ??
                 // 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,
+            uses: overrides?.uses,
+            withContent: overrides?.withContent,
+            shell: overrides?.shell,
+            env: overrides?.env,
+            timeoutMinutes: overrides?.timeoutMinutes,
+            continueOnError: overrides?.continueOnError,
           ),
         );
       }
@@ -438,49 +443,54 @@ class _CommandEntryBase {
   Iterable<Step> get runContent => [Step.run(name: name, run: run)];
 }
 
-class _CommandEntry extends _CommandEntryBase {
+class _CommandEntry extends _CommandEntryBase implements GitHubActionOverrides {
   final TaskType? type;
+
+  @override
   final String? id;
-  final String? ifCondition;
+
+  @override
+  final String? ifContent;
+
+  @override
   final String workingDirectory;
+
+  @override
   final String? uses;
+
+  @override
   final Map<String, String>? env;
-  final Map<String, String>? inputs;
+
+  @override
+  final Map<String, dynamic>? withContent;
+
+  @override
   final String? shell;
 
+  @override
+  final bool? continueOnError;
+
+  @override
+  final int? timeoutMinutes;
+
   _CommandEntry(
     super.name,
     super.run, {
     required this.workingDirectory,
     this.type,
     this.id,
-    this.ifCondition,
+    this.ifContent,
     this.uses,
     this.env,
-    this.inputs,
+    this.withContent,
     this.shell,
+    this.continueOnError,
+    this.timeoutMinutes,
   });
 
   @override
   Iterable<Step> get runContent => [
-        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,
-          ),
+        Step.fromOverrides(this),
         ...?type?.afterEachSteps(workingDirectory),
       ];
 }

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

@@ -0,0 +1,38 @@
+abstract class GitHubActionOverrides {
+  /// The step's identifier, which can be used to refer to the step and its
+  /// outputs in the [ifContent] property of this and other steps.
+  String? get id;
+
+  /// The name of the step.
+  String? get name;
+
+  /// The shell command to run for this step.
+  String? get run;
+
+  /// The GitHub action identifier, e.g. `actions/checkout@v3`.
+  String? get uses;
+
+  /// The inputs to the action.
+  ///
+  /// A map of key-value pairs which are passed to the action's `with`
+  /// parameter.
+  Map<String, dynamic>? get withContent;
+
+  /// The condition on which to run this action.
+  String? get ifContent;
+
+  /// The directory in which to run this action.
+  String? get workingDirectory;
+
+  /// The shell override for this action.
+  String? get shell;
+
+  /// The environment variables for the step.
+  Map<String, String>? get env;
+
+  /// Prevents a job from failing when a step fails.
+  bool? get continueOnError;
+
+  /// The number of minutes to allow the step to run.
+  int? get timeoutMinutes;
+}

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

@@ -5,6 +5,7 @@
 import 'package:json_annotation/json_annotation.dart';
 
 import '../../yaml.dart';
+import 'overrides.dart';
 
 part 'step.g.dart';
 
@@ -13,24 +14,40 @@ part 'step.g.dart';
   includeIfNull: false,
   constructor: '_',
 )
-class Step implements YamlLike {
+class Step implements GitHubActionOverrides, YamlLike {
+  @override
   final String? id;
+  @override
   final String? name;
+  @override
   final String? run;
 
+  @override
   @JsonKey(name: 'if')
   final String? ifContent;
+
+  @override
   @JsonKey(name: 'working-directory')
   final String? workingDirectory;
 
-  final Map? env;
+  @override
+  final Map<String, String>? env;
 
+  @override
   final String? uses;
+  @override
   @JsonKey(name: 'with')
-  final Map? withContent;
+  final Map<String, dynamic>? withContent;
 
+  @override
   final String? shell;
 
+  @override
+  final bool? continueOnError;
+
+  @override
+  final int? timeoutMinutes;
+
   Step._({
     this.id,
     this.withContent,
@@ -41,7 +58,16 @@ class Step implements YamlLike {
     this.workingDirectory,
     this.env,
     this.shell,
+    this.continueOnError,
+    this.timeoutMinutes,
   }) {
+    if (name == null) {
+      throw ArgumentError.value(
+        name,
+        'name',
+        '`name` must be defined.',
+      );
+    }
     if (run == null) {
       if (uses == null) {
         throw ArgumentError.value(
@@ -67,6 +93,21 @@ class Step implements YamlLike {
     }
   }
 
+  Step.fromOverrides(GitHubActionOverrides overrides)
+      : this._(
+          id: overrides.id,
+          name: overrides.name,
+          uses: overrides.uses,
+          withContent: overrides.withContent,
+          workingDirectory: overrides.workingDirectory,
+          run: overrides.run,
+          env: overrides.env,
+          shell: overrides.shell,
+          ifContent: overrides.ifContent,
+          continueOnError: overrides.continueOnError,
+          timeoutMinutes: overrides.timeoutMinutes,
+        );
+
   Step.run({
     this.id,
     required String this.name,
@@ -75,6 +116,8 @@ class Step implements YamlLike {
     this.workingDirectory,
     this.env,
     this.shell,
+    this.continueOnError,
+    this.timeoutMinutes,
   })  : uses = null,
         withContent = null;
 
@@ -84,6 +127,8 @@ class Step implements YamlLike {
     required this.uses,
     this.withContent,
     this.ifContent,
+    this.continueOnError,
+    this.timeoutMinutes,
   })  : run = null,
         env = null,
         workingDirectory = null,