example.yaml

name: Example

# Only one workflow can run at a time
# If there is newer workflow in progress, cancel older ones
concurrency:
  group: example
  cancel-in-progress: true

# Put 'on' in quotes to avoid YAML parsing error
"on":
  # Enable manual triggering
  workflow_dispatch: {}
  # Run on commits to main branch
  push:
    branches:
      - main
    # Run only on changes to relevant files
    paths:
      - .github/workflows/example.yaml
      - src/**
      - copier.yaml
      - flake.lock
      - "*.nix"
      - Taskfile.dist.yaml

jobs:
  build:
    name: Build template
    # Pin version of Ubuntu to avoid breaking changes
    runs-on: ubuntu-24.04
    # Use reasonable timeout to avoid stuck workflows
    timeout-minutes: 10
    env:
      NIX_CACHE_DIR: /home/runner/.nixcache/
    permissions:
      # Needed to checkout code
      contents: read
    steps:
      - name: Checkout code
        uses: actions/checkout@v5.0.0
      - name: Setup Nix cache
        uses: actions/cache@v4.3.0
        id: cache-nix
        with:
          path: ${{ env.NIX_CACHE_DIR }}
          key: example-nix
      - name: Install Nix
        uses: cachix/install-nix-action@v31.8.4
        with:
          github_access_token: ${{ github.token }}
          install_url: https://releases.nixos.org/nix/nix-2.28.5/install
      # See: https://github.com/cachix/install-nix-action/issues/56
      - name: Import Nix store cache
        if: steps.cache-nix.outputs.cache-hit == 'true'
        run: >-
          nix-store
          --import
          < ${{ env.NIX_CACHE_DIR }}/archive.nar
      - name: Build template files
        run: >-
          nix
          develop
          ./#template
          --command
          --
          task
          shallow-build
          --
          --data
          'accountname=quickplates'
          --data
          'appname=next-example'
          --data
          'reponame=next-example'
          --data
          'description=Next.js app example ⚫'
      # Create archive to retain file permissions
      - name: Create archive
        run: >-
          tar
          --directory
          build/
          --create
          --verbose
          --file
          archive.tar
          ./
      - name: Upload artifact
        uses: actions/upload-artifact@v5.0.0
        with:
          include-hidden-files: true
          name: build
          path: archive.tar
      # See: https://github.com/cachix/install-nix-action/issues/56
      - name: Export Nix store cache
        if: "!cancelled()"
        run: >-
          mkdir
          --parents
          ${{ env.NIX_CACHE_DIR }}
          &&
          nix-store
          --export $(find /nix/store/ -maxdepth 1 -name '*-*')
          > ${{ env.NIX_CACHE_DIR }}/archive.nar
  push:
    name: Push changes
    # Run only if build job succeeded
    needs: build
    # Pin version of Ubuntu to avoid breaking changes
    runs-on: ubuntu-24.04
    # Use reasonable timeout to avoid stuck workflows
    timeout-minutes: 10
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v6.0.0
        with:
          name: build
      - name: Extract archive
        run: >-
          mkdir
          --parents
          build/
          &&
          tar
          --directory
          build/
          --extract
          --verbose
          --file
          archive.tar
      - name: Checkout example repository
        uses: actions/checkout@v5.0.0
        with:
          repository: quickplates/next-example
          token: ${{ secrets.EXAMPLES_ACCESS_TOKEN }}
          # Needed to reset to first commit
          fetch-depth: 0
          path: example/
      # Configure git to use GitHub Actions bot as committer
      - name: Configure git
        working-directory: example/
        run: >-
          git
          config
          user.name
          "github-actions[bot]"
          &&
          git
          config
          user.email
          "41898282+github-actions[bot]@users.noreply.github.com"
      - name: Reset example repository to first commit
        working-directory: example/
        run: >-
          git
          reset
          --hard
          "$(git rev-list --max-parents=0 HEAD)"
      - name: Push changes
        working-directory: example/
        run: >-
          git
          push
          --force
          origin
          HEAD
      - name: Create new branch
        working-directory: example/
        run: >-
          git
          checkout
          -b
          build
      - name: Copy build output
        run: >-
          cp
          --recursive
          build/.
          example/
      - name: Add changes
        working-directory: example/
        run: >-
          git
          add
          ./
      - name: Commit changes
        working-directory: example/
        run: >-
          git
          commit
          --message
          'Added template files'
      - name: Push changes
        working-directory: example/
        run: >-
          git
          push
          --force
          origin
          HEAD
      - name: Create pull request
        working-directory: example/
        env:
          GITHUB_TOKEN: ${{ secrets.EXAMPLES_ACCESS_TOKEN }}
        run: >-
          gh
          pr
          create
          --title
          'Added template files'
          --body
          'Created automatically by GitHub Actions workflow from
          [`${{ github.repository }}`](
          ${{ github.server_url }}/${{ github.repository }}
          ).'
          --base
          main
          --assignee
          '@me'
          --fill
          --label
          'feature'
      - name: Delete all releases and tags
        working-directory: example/
        env:
          GITHUB_TOKEN: ${{ secrets.EXAMPLES_ACCESS_TOKEN }}
        run: >-
          gh
          release
          list
          |
          awk
          --field-separator
          '\t'
          '{print $3}'
          |
          while
          read
          -r
          tag
          ;
          do
          gh
          release
          delete
          "$tag"
          --yes
          --cleanup-tag
          ;
          done
      - name: Merge pull request
        working-directory: example/
        env:
          GITHUB_TOKEN: ${{ secrets.EXAMPLES_ACCESS_TOKEN }}
        run: >-
          gh
          pr
          merge
          --auto
          --delete-branch
          --squash
      - name: Fetch changes from origin
        working-directory: example/
        run: >-
          git
          fetch
          --prune
          --prune-tags
          origin
      - name: Create release
        working-directory: example/
        env:
          GITHUB_TOKEN: ${{ secrets.EXAMPLES_ACCESS_TOKEN }}
        run: >-
          gh
          release
          create
          0.1.0
          --generate-notes