feat(cli): allows filtering by Earthfile content (#185)

Author: jmgilman

.github/workflows/ci.yml

@@ -17,6 +17,21 @@ on:
         required: false
         type: boolean
         default: false
+      tags:
+        description: A newline separated list of tags to filter Earthly targets by
+        required: false
+        type: string
+        default: ""
+      skip_release:
+        description: Skip the release job
+        required: false
+        type: boolean
+        default: false
+      skip_deploy:
+        description: Skip the deploy job
+        required: false
+        type: boolean
+        default: false
       verbosity:
         description: The verbosity level to use
         required: false
@@ -36,7 +51,6 @@ env:
   FORGE_REGEX_DOCS: ^docs(-.*)?$
   FORGE_REGEX_RELEASE: ^release(-.*)?$
   FORGE_REGEX_PUBLISH: ^publish(-.*)?$
-  FORGE_REGEX_NIGHTLY: ^nightly(-.*)?$
 
 jobs:
   discover:
@@ -81,6 +95,7 @@ jobs:
             ${{ env.FORGE_REGEX_RELEASE }}
             ${{ env.FORGE_REGEX_PUBLISH }}
             ${{ env.FORGE_REGEX_NIGHTLY }}
+          tags: ${{ inputs.tags }}
   check:
     uses: input-output-hk/catalyst-forge/.github/workflows/run.yml@master
     needs: [discover]
@@ -125,21 +140,10 @@ jobs:
       skip_output: true
       verbosity: ${{ inputs.verbosity }}
 
-  nightly:
-    uses: input-output-hk/catalyst-forge/.github/workflows/run.yml@master
-    needs: [discover, check, build, package]
-    if: (fromJson(needs.discover.outputs.earthfiles)['^nightly(-.*)?$'] != null) && (inputs.release_only == false) && !failure() && !cancelled() && inputs.nightly == true
-    with:
-      earthfiles: ${{ toJson(fromJson(needs.discover.outputs.earthfiles)['^nightly(-.*)?$']) }}
-      forge_version: ${{ inputs.forge_version }}
-      local: ${{ inputs.local }}
-      skip_output: true
-      verbosity: ${{ inputs.verbosity }}
-
   release:
     uses: input-output-hk/catalyst-forge/.github/workflows/release.yml@master
     needs: [discover, check, build, test]
-    if: (fromJson(needs.discover.outputs.releases)[0] != null) && !failure() && !cancelled()
+    if: (fromJson(needs.discover.outputs.releases)[0] != null) && !inputs.skip_release && !failure() && !cancelled()
     with:
       releases: ${{ needs.discover.outputs.releases }}
       forge_version: ${{ inputs.forge_version }}
@@ -149,15 +153,15 @@ jobs:
   deploy:
     uses: input-output-hk/catalyst-forge/.github/workflows/deploy.yml@master
     needs: [discover, check, build, test, release]
-    if: (fromJson(needs.discover.outputs.deployments)[0] != null) && !failure() && !cancelled()
+    if: (fromJson(needs.discover.outputs.deployments)[0] != null) && !inputs.skip_deploy && !failure() && !cancelled()
     with:
       deployments: ${{ needs.discover.outputs.deployments }}
       forge_version: ${{ inputs.forge_version }}
       local: ${{ inputs.local }}
       verbosity: ${{ inputs.verbosity }}
 
   final:
-    needs: [check, build, package, test, nightly, release, deploy]
+    needs: [check, build, package, test, release, deploy]
     if: ${{ always() && (contains(needs.*.result, 'failure') || !failure() && !cancelled()) }}
     runs-on: ubuntu-latest
     steps:

.github/workflows/dogfood.yml

@@ -17,6 +17,5 @@ jobs:
     uses: ./.github/workflows/ci.yml
     with:
       forge_version: local
-      verbosity: debug
-      nightly: true
-      release_only: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/') }}
+      release_only: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/') }}
+      verbosity: debug

actions/discovery/action.yml

@@ -10,6 +10,9 @@ inputs:
   path:
     description: The path to search from
     default: "."
+  tags:
+    description: A newline separated list of tags to filter Earthly targets by
+    default: ""
 outputs:
   deployments:
     description: The deployments discovered

actions/discovery/dist/index.js

@@ -4,11 +4,12 @@ const exec = require("@actions/exec");
 async function run() {
   try {
     const absolute = core.getBooleanInput("absolute", { required: false });
-    const path = core.getInput("path", { required: true });
     const filters = core.getInput("filters", { required: false });
+    const path = core.getInput("path", { required: true });
+    const tags = core.getInput("tags", { required: false });
 
     await runDeploymentScan(absolute, path);
-    await runEarthfileScan(filters, absolute, path);
+    await runEarthfileScan(filters, absolute, path, tags);
     await runReleaseScan(absolute, path);
   } catch (error) {
     core.setFailed(error.message);
@@ -25,7 +26,7 @@ module.exports = {
  * @param {string} path The path to scan
  */
 async function runDeploymentScan(absolute, path) {
-  const args = ["-vv", "scan", "--blueprint", "--filter", "project.deployment"];
+  const args = ["-vv", "scan", "blueprint", "--filter", "project.deployment"];
 
   if (absolute === true) {
     args.push("--absolute");
@@ -46,14 +47,15 @@ async function runDeploymentScan(absolute, path) {
  * @param {boolean} absolute Whether to use absolute paths or not
  * @param {string} path The path to scan
  */
-async function runEarthfileScan(filters, absolute, path) {
-  let args = ["-vv", "scan", "--ci", "--earthfile"];
+async function runEarthfileScan(filters, absolute, path, tags) {
+  let args = ["-vv", "scan", "earthfile", "--enumerate"];
 
   if (absolute === true) {
     args.push("--absolute");
   }
 
   args = args.concat(filtersToArgs(filters));
+  args = args.concat(tagsToArgs(tags));
   args.push(path);
 
   core.info(`Running forge ${args.join(" ")}`);
@@ -69,7 +71,7 @@ async function runEarthfileScan(filters, absolute, path) {
  * @param {string} path The path to scan
  */
 async function runReleaseScan(absolute, path) {
-  const args = ["-vv", "scan", "--blueprint", "--filter", "project.release"];
+  const args = ["-vv", "scan", "blueprint", "--filter", "project.release"];
 
   if (absolute === true) {
     args.push("--absolute");
@@ -103,3 +105,19 @@ function filtersToArgs(input) {
 
   return result;
 }
+
+/**
+ * Converts the tags input string to command line arguments.
+ * @param {string} input The tags input string
+ * @returns {string[]} The tags as command line arguments
+ */
+function tagsToArgs(input) {
+  const lines = input.trim().split("\n");
+
+  const result = [];
+  for (const line of lines) {
+    result.push("--tag", line);
+  }
+
+  return result;
+}

actions/discovery/dist/index.js.map

@@ -0,0 +1,112 @@
+# Reject Earthfile Action
+
+This GitHub Action scans for Earthfiles that match certain filter expressions and fails the workflow if any matches are found. This is useful for enforcing policies or preventing certain patterns in Earthfiles.
+
+## Inputs
+
+### `filters` (required)
+
+A newline-separated list of filter expressions and error messages. Each expression should be on its own line, followed by its error message on the next line.
+
+**Example:**
+
+```
+prod
+contain production targets
+debug
+contain debug targets
+```
+
+### `root-path` (optional)
+
+The root path to scan for Earthfiles. Defaults to the current directory (`.`).
+
+### `filter-source` (optional)
+
+The source to filter by. Can be either `"earthfile"` or `"targets"`. Defaults to `"targets"`.
+
+- `"targets"`: Filter by target names in Earthfiles
+- `"earthfile"`: Filter by Earthfile contents
+
+### `verbosity` (optional)
+
+The verbosity level for the forge command. Can be `"error"`, `"info"`, or `"debug"`. Defaults to `"info"`.
+
+## Usage
+
+### Basic Example
+
+```yaml
+- name: Reject Earthfiles with production targets
+  uses: ./.github/actions/reject-earthfile
+  with:
+    filters: |
+      prod
+      contain production targets
+```
+
+### Multiple Filters
+
+```yaml
+- name: Reject problematic Earthfiles
+  uses: ./.github/actions/reject-earthfile
+  with:
+    filters: |
+      prod
+      contain production targets
+      debug
+      contain debug targets
+      test
+      contain test targets
+```
+
+### Filter by Earthfile Contents
+
+```yaml
+- name: Reject Earthfiles with certain content
+  uses: ./.github/actions/reject-earthfile
+  with:
+    filters: |
+      FROM alpine
+      use Alpine base image
+    filter-source: "earthfile"
+```
+
+### Custom Root Path
+
+```yaml
+- name: Reject Earthfiles in specific directory
+  uses: ./.github/actions/reject-earthfile
+  with:
+    filters: |
+      prod
+      contain production targets
+    root-path: "./apps"
+```
+
+## Output Format
+
+When rejections are found, the action will output a message in this format:
+
+```
+The following Earthfiles contain production targets:
+- ./path/to/earthfile1+target1
+- ./path/to/earthfile2+target2
+
+The following Earthfiles contain debug targets:
+- ./path/to/earthfile3+target3
+```
+
+## Filter Expressions
+
+The filter expressions are regular expressions that are matched against either:
+
+- Target names (when `filter-source` is `"targets"`)
+- Earthfile contents (when `filter-source` is `"earthfile"`)
+
+### Examples
+
+- `"prod"` - Matches any target or content containing "prod"
+- `"^prod"` - Matches targets or content starting with "prod"
+- `"prod$"` - Matches targets or content ending with "prod"
+- `"prod|staging"` - Matches targets or content containing "prod" or "staging"

actions/discovery/src/main.js

@@ -0,0 +1,28 @@
+name: Reject Earthfile
+description: Reject Earthfiles that match certain filter expressions
+inputs:
+  filters:
+    description: |
+      Newline-separated list of filter expressions and error messages.
+      Format: "expr1
+      error message 1
+      expr2
+      error message 2"
+      Each expression should be on its own line, followed by its error message on the next line.
+    required: true
+  root-path:
+    description: Root path to scan for Earthfiles
+    required: false
+    default: "."
+  filter-source:
+    description: The source to filter by [earthfile | targets]
+    required: false
+    default: "targets"
+  verbosity:
+    description: The verbosity level to use
+    required: false
+    default: "info"
+
+runs:
+  using: node20
+  main: dist/index.js