https://github.com/developer-friendly/selective-builds-actions

GitHub Action to identity changed directories/applications for selective builds.
https://github.com/developer-friendly/selective-builds-actions

build build-automation build-tool build-tools github-actions monolith monorepo selective-build selective-builds

Last synced: about 2 months ago
JSON representation

GitHub Action to identity changed directories/applications for selective builds.

• Host: GitHub
• URL: https://github.com/developer-friendly/selective-builds-actions
• Owner: developer-friendly
• License: apache-2.0
• Created: 2024-08-02T10:00:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-29T11:47:44.000Z (2 months ago)
• Last Synced: 2026-01-29T15:30:19.204Z (2 months ago)
• Topics: build, build-automation, build-tool, build-tools, github-actions, monolith, monorepo, selective-build, selective-builds
• Language: JavaScript
• Homepage:
• Size: 8.36 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Selective Build Actions

- [Selective Build Actions](#selective-build-actions)

  - [Example - Build Docker](#example---build-docker)

This action will perform a hash function on the first depth of directories

specified at `path`, calculate a unique SHA256 hash on the files inside, and

generate a unique string for each directory.

It then uses that string to compare future CI runs against he one computed

before, signaling a change in the target directory, possibly allowing a further

job to execute a build of the application in the change directory.

It is useful for selective builds on monorepos when it is desired and costly

justified to build only the directories that have changed.

It does not hold any opinions on how you build your apps; you are free to pick

whatever's best for your stack. However, for the purpose of demonstration, you

will find a Docker build example below.

This action relies on GitHub Action's dynamic

[matrix](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-jobs),

a topic that has been covered in

[here](https://developer-friendly.blog/2024/03/09/github-actions-dynamic-matrix/).

## Example - Build Docker

```yaml

name: ci

on:

  push:

    branches:

      - main

  schedule:

    - cron: "0 0 * * *"

jobs:

  prepare:

    runs-on: ubuntu-latest

    permissions:

      contents: read

    outputs:

      matrix: ${{ steps.matrix.outputs.matrix }}

      length: ${{ steps.matrix.outputs.length }}

    steps:

      - uses: actions/checkout@v4

        name: Checkout

      - id: matrix

        name: Discover changed services

        uses: developer-friendly/selective-builds-actions@v1

        with:

          redis-host: ${{ secrets.REDIS_HOST }}

          redis-port: ${{ secrets.REDIS_PORT }}

          redis-password: ${{ secrets.REDIS_PASSWORD }}

          redis-ssl: ${{ secrets.REDIS_SSL }}

          exclusions: |

            .git

            .github

          inclusions: |

            frontend

            backend

            api

  build:

    needs: prepare

    runs-on: ubuntu-latest

    if: needs.prepare.outputs.length > 0

    strategy:

      fail-fast: false

      matrix: ${{ fromJson(needs.prepare.outputs.matrix) }}

    permissions:

      contents: read

      packages: write

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Set up QEMU

        uses: docker/setup-qemu-action@v3

      - name: Set up Docker Buildx

        uses: docker/setup-buildx-action@v3

      - name: Login to GitHub Container Registry

        uses: docker/login-action@v3

        with:

          password: ${{ secrets.GITHUB_TOKEN }}

          registry: ghcr.io

          username: ${{ github.actor }}

      - name: Pre-process image name

        id: image-name

        run: |

          name=$(echo ${{ matrix.directory }} | sed 's/.*\///')

          echo "name=$name" >> $GITHUB_OUTPUT

      - id: meta

        name: Docker metadata

        uses: docker/metadata-action@v5

        with:

          images: ghcr.io/${{ github.repository }}/${{ steps.image-name.outputs.name }}

      - id: build-push

        name: Build and push

        uses: docker/build-push-action@v6

        with:

          cache-from: type=gha

          cache-to: type=gha,mode=max

          context: ${{ matrix.directory }}

          labels: ${{ steps.meta.outputs.labels }}

          platforms: linux/amd64,linux/arm64

          push: true

          tags: |

            ${{ steps.meta.outputs.tags }}

  finalize:

    runs-on: ubuntu-latest

    needs: build

    permissions:

      contents: read

    steps:

      - uses: actions/checkout@v4

        name: Checkout

      - id: matrix

        name: Discover changed services

        uses: developer-friendly/selective-builds-actions@v1

        with:

          redis-host: ${{ secrets.REDIS_HOST }}

          redis-port: ${{ secrets.REDIS_PORT }}

          redis-password: ${{ secrets.REDIS_PASSWORD }}

          redis-ssl: ${{ secrets.REDIS_SSL }}

          mode: submit

          exclusions: |

            .git

            .github

          inclusions: |

            frontend

            backend

            api

```