feat: allow ignoring certain actions (#278)

The immediate motivation is being able to use this action within this
very repo - there are some actions used in tests that don't have valid
typings, so we need to ignore them.

Author: krzema12

action-types.yml

@@ -0,0 +1,6 @@
+inputs:
+  ignored-action-files:
+    type: list
+    separator: "\n"
+    list-item:
+      type: string

action.yaml

@@ -7,3 +7,9 @@ branding:
 runs:
   using: 'docker'
   image: 'Dockerfile'
+inputs:
+  ignored-action-files:
+    description: >
+      Paths to 'action.y(a)ml' files that shouldn't be validated against their typings.
+      The separator character is '/', regardless of the operating system.
+    required: false

src/jvmMain/kotlin/it/krzeminski/githubactionstyping/Logic.kt

@@ -5,26 +5,31 @@ import it.krzeminski.githubactionstyping.reporting.appendStatus
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 import java.nio.file.Path
 import kotlin.io.path.exists
+import kotlin.io.path.invariantSeparatorsPathString
 import kotlin.io.path.name
-import kotlin.io.path.nameWithoutExtension
-import kotlin.io.path.pathString
 import kotlin.io.path.walk
 
 /**
  * Runs validation for a given action, with its manifest files present in the current directory.
  *
+ * @param ignoredActionFiles: Paths to 'action.y(a)ml' files that shouldn't be validated against their typings.
+ *        The separator character is '/', regardless of the operating system.
  * @param repoRoot: Allows customizing which path should be taken as repo root for action(-types).y(a)ml file discovery.
  *
  * @return a pair where:
  * - the boolean means if the typings are valid
  * - the string is a printable report, with details about all inputs and outputs
  */
-fun validateTypings(repoRoot: Path = Path.of(".")): Pair<Boolean, String> {
+fun validateTypings(
+    ignoredActionFiles: List<String> = emptyList(),
+    repoRoot: Path = Path.of("."),
+): Pair<Boolean, String> {
     require(repoRoot.exists()) { "The given repo root leads to non-existent dir: $repoRoot" }
 
     val validationResultsForActions = repoRoot.walk()
         .sorted()
         .filter { it.name in setOf("action.yml", "action.yaml") }
+        .filter { repoRoot.relativize(it).invariantSeparatorsPathString !in ignoredActionFiles }
         .map { manifestPath ->
             val manifest = repoRoot.readYamlFile(manifestPath.parent.resolve("action").toString())
             val typesManifest = repoRoot.readYamlFile(manifestPath.parent.resolve("action-types").toString())

src/jvmMain/kotlin/it/krzeminski/githubactionstyping/Main.kt

@@ -3,10 +3,15 @@ package it.krzeminski.githubactionstyping
 import kotlin.system.exitProcess
 
 fun main() {
-    val (isValid, report) = validateTypings()
+    val (isValid, report) = validateTypings(
+        ignoredActionFiles = readIgnoredActionFiles(),
+    )
     println(report)
 
     if (!isValid) {
         exitProcess(1)
     }
 }
+
+private fun readIgnoredActionFiles(): List<String> =
+    System.getenv("INPUT_IGNORED-ACTION-FILES")?.split("\n") ?: emptyList()

src/jvmTest/kotlin/it/krzeminski/githubactionstyping/LogicTest.kt

@@ -250,6 +250,38 @@ class LogicTest : FunSpec({
         }
     }
 
+    test("repo with top-level action with valid typings, and nested action with invalid typings that are ignored") {
+        // When
+        val (isValid, report) = validateTypings(
+            repoRoot = testRepos.resolve("repo-with-top-level-and-nested-action-and-invalid-typings"),
+            ignoredActionFiles = listOf("some/directory/action.yaml"),
+        )
+
+        // Then
+        assertSoftly {
+            isValid shouldBe true
+            report shouldBe """
+                Overall result:
+                ✔ VALID
+
+                For action with manifest at 'action.yml':
+                Result:
+                ${'\u001b'}[32m✔ VALID${'\u001b'}[0m
+
+                Inputs:
+                • verbose:
+                  ${'\u001b'}[32m✔ VALID${'\u001b'}[0m
+                • someEnum:
+                  ${'\u001b'}[32m✔ VALID${'\u001b'}[0m
+
+                Outputs:
+                None.
+
+
+            """.trimIndent()
+        }
+    }
+
     test("repo with only top-level action and no top-level manifest") {
         // When
         val (isValid, report) = validateTypings(