Find Exec

Glob the filesystem to create matrix definitions for parallel jobs. This action uses globby under the hood

Usage

Simple

steps:
  - uses: actions/checkout@v4
  - run: tree
    # .
    # ├── function-a
    # │   └── file.txt
    # ├── function-b
    # │   └── file.txt
    # └── other-folder
    #     └── file.txt
  - id: find-exec
    uses: colpal/[email protected]
    with:
      patterns: |
        **/file.txt
        !other-folder/*
  - run: echo ${{ steps.find-exec.outputs.matches }}
    # ["function-a/file.txt","function-b/file.txt"]

Static Parallel

jobs:
  divide:
    steps:
      - uses: actions/checkout@v4
      - run: tree
        # .
        # ├── function-a
        # │   ├── main.py
        # │   └── deploy.sh
        # ├── function-b
        # │   ├── main.js
        # │   └── deploy.sh
        # └── other-folder
        #     ├── main.js
        #     └── deploy.sh
      - id: find-exec
        uses: colpal/[email protected]
        with:
          patterns: 'function-*'
    outputs:
      # ["function-a/", "function-b/"]
      matches: ${{ steps.find-exec.outputs.matches }}

  conquer:
    needs: divide
    strategy:
      matrix:
        path: ${{ fromJSON(needs.divide.outputs.matches) }}
    steps:
      - uses: actions/checkout@v4
      - run: ./deploy.sh
        working-directory: ${{ matrix.path }}

Reference

For more details on the supported patterns, see here

steps:
  - id: find-exec
    uses: colpal/[email protected]
    with:
      # REQUIRED (if `root-patterns` is not specified)
      # The pattern(s) to be used to find folders/files. More than one pattern
      # may be supplied by putting each on its own line.
      patterns: single-line string | multi-line string

      # OPTIONAL
      # DEFAULT = The filesystem
      # The source that will be globbed/searched by patterns/filter-patterns.
      # If not supplied, the filesystem will be globbed/searched. If supplied,
      # must be a list of filepaths
      source: JSON-formatted array of strings

      # OPTIONAL (only valid if `root-patterns` is specified)
      # DEFAULT = **
      # The pattern(s) to be used to find files/folders to provide to
      # `root-patterns` (see the description of `root-patterns` for more
      # details)
      filter-patterns: single-line string | multi-line string

      # REQUIRED (if `patterns` is not specified)
      # The pattern(s) to be used to "hoist" files/folders matched by
      # `filter-patterns`. The process is as follows:
      #   1. `filter-patterns` is applied to the filesystem to create a list
      #      of paths (similar to what `patterns` does when specified alone)
      #   2. `root-patterns` is then applied to the paths from the previous
      #      step. Any paths that match will be added to the `matches` output.
      #   3. `dirname` will be applied to all paths from step 2 that DID NOT
      #      match `root-patterns`, effectively removing the last segment of
      #      the path. For example:
      #        `folder-a/subfolder-a/file-a` becomes `folder-a/subfolder-a/`
      #        `folder-a/subfolder-a/`       becomes `folder-a/`
      #        `folder-a/`                   becomes `./`
      #        `./`                          becomes `./`
      #   4. Repeat steps 2 - 4 until the only unmatched paths are "./"
      #   5. `matches` is set as an output of the action
      root-patterns: single-line string | multi-line string
outputs:
  # An JSON-formatted array of paths that matched the pattern(s)
  matches: ${{ steps.find-exec.outputs.matches }}

Recipes

Find all folders that contain certain files

- uses: colpal/[email protected]
  with:
    root-patterns: |
      ./
      **/
    filter-patterns: |
      **/main.sh
      **/start.sh

Build Docker contexts

.
└── containers
    ├── container-a
    │   ├── Dockerfile
    │   ├── main.py
    │   └── requirements.txt
    └── container-b
        ├── Dockerfile
        ├── main.js
        └── package.json

jobs:
  divide:
    steps:
      - uses: actions/checkout@v4
      - id: find-exec
        uses: colpal/[email protected]
        with:
          root-patterns: |
            containers/*/
          filter-patterns: |
            containers/*/**
    outputs:
      matches: ${{ steps.find-exec.outputs.matches }}

  conquer:
    needs: divide
    strategy:
      matrix:
        path: ${{ fromJSON(needs.divide.outputs.matches) }}
    defaults:
      run:
        working-directory: ./${{ matrix.path }}
    steps:
      - uses: actions/checkout@v4
      - run: docker build

Build Docker contexts if they have changed

.
└── containers
    ├── container-a
    │   ├── Dockerfile
    │   ├── main.py
    │   └── requirements.txt
    └── container-b
        ├── Dockerfile
        ├── main.js
        └── package.json

jobs:
  divide:
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - id: changed
        uses: colpal/actions-changed-files@v3
      - id: find-exec
        uses: colpal/[email protected]
        with:
          root-patterns: |
            containers/*/
          filter-patterns: |
            containers/*/**
          source: ${{ toJSON(fromJSON(steps.changed.outputs.json).all) }}
    outputs:
      matches: ${{ steps.find-exec.outputs.matches }}

  conquer:
    needs: divide
    strategy:
      matrix:
        path: ${{ fromJSON(needs.divide.outputs.matches) }}
    defaults:
      run:
        working-directory: ./${{ matrix.path }}
    steps:
      - uses: actions/checkout@v4
      - run: docker build