dorothy-workflow.yml

# don't use [shell: bash] unless needed, as for macos-fresh that caused an infinite queue for the test step, and for linux bash may not exist yet
# https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
name: dorothy-workflow
on:
  - push
  - pull_request
concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: true
jobs:
  debug-env:
    runs-on: ubuntu-latest
    steps:
      - name: 'Debug Environment'
        shell: bash -leo pipefail {0}
        run: |
          # output github context
          cat <<-EGITHUB
            run?
            ${{ toJson( github.event_name == 'push' || ( github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) == 'false' && toJson(github.event.pull_request.state) == '"open"' && toJson(github.event.pull_request.assignees) != '[]' ) ) }}

            github.event_name:
            ${{ toJson(github.event_name) }}

            github.event.pull_request.draft:
            ${{ github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) }}

            github.event.pull_request.state:
            ${{ github.event_name == 'pull_request' && toJson(github.event.pull_request.state) }}

            github.event.pull_request.assignees:
            ${{ github.event_name == 'pull_request' && toJson( toJson(github.event.pull_request.assignees) != '[]' ) }}

            github.repository:
            ${{ toJson(github.repository) }}

            github.event.pull_request.head.repo.full_name:
            ${{ github.event_name == 'pull_request' && toJson(github.event.pull_request.head.repo.full_name) }}

            github.event.pull_request.head.sha:
            ${{ github.event_name == 'pull_request' && toJson(github.event.pull_request.head.sha) }}

            github.sha:
            ${{ toJson(github.sha) }}

            github.ref
            ${{ toJson(github.ref) }}

            resolved slug:
            ${{ toJson(github.event.pull_request.head.repo.full_name || github.repository) }}

            resolved sha:
            ${{ toJson(github.event.pull_request.head.sha || github.sha) }}

            github:
            ${{ false && toJson(github) }}
          EGITHUB
  login-shells-and-linting:
    if: github.event_name == 'push' || ( github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) == 'false' && toJson(github.event.pull_request.state) == '"open"' && toJson(github.event.pull_request.assignees) != '[]' )
    runs-on: ubuntu-latest
    steps:
      - name: 'Dorothy Install'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
        run: |
          # ensure dorothy is cloned, and run command
          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/install?slug=${{ github.event.pull_request.head.repo.full_name || github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')"
      - name: 'Dorothy Configure'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
        shell: bash -leo pipefail {0}
        run: |
          # prep linting
          dorothy dev
          # prep login shells
          setup-util-bash
          setup-util-zsh
          setup-util-fish
          setup-util-nu
          setup-util-xonsh
          setup-util-elvish
          setup-util-dash
          setup-util-ksh
          setup-util-carapace
          dorothy --slug=${{ github.event.pull_request.head.repo.full_name || github.repository }} install
          # nu -c 'echo $nu.loginshell-path'
      - name: 'Dorothy Login Shell: bash'
        shell: bash -leo pipefail {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: zsh'
        shell: zsh -l {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: fish'
        shell: fish -l {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: nu'
        shell: nu -l {0}
        run: |
          # source ... is a workaround for: https://discord.com/channels/601130461678272522/1147584426121896067
          # source '/Users/runner/Library/Application Support/nushell/login.nu' # macos
          source '/home/runner/.config/nushell/login.nu' # linux
          # continue as normal
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: xonsh'
        env:
          PKG_CONFIG_PATH: '' # fix: https://github.com/bevry/dorothy/actions/runs/6349881708/job/17248752072#step:8:8
          LDFLAGS: '' # fix: https://github.com/bevry/dorothy/actions/runs/6349927188/job/17248892389#step:8:9
          CPPFLAGS: '' # fix: https://github.com/bevry/dorothy/actions/runs/6349956372/job/17248986621#step:8:10
          CXX: '' # fix: https://github.com/bevry/dorothy/actions/runs/7538723888/job/20519802798#step:8:12
          CC: '' #fix: https://github.com/bevry/dorothy/actions/runs/7538922544/job/20520381661#step:8:13
        shell: xonsh -DXONSH_SHOW_TRACEBACK=True -l {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: elvish'
        shell: elvish {0}
        run: |
          # when given a file, elvish no longer loads its rc file (which is intended for a TTY), so we load ourself:
          # for details see: https://github.com/elves/elvish/issues/1726
          eval (cat '/home/runner/.local/share/dorothy/init.elv' | slurp)
          # continue as normal
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: dash'
        shell: dash -l {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Dorothy Login Shell: ksh'
        shell: ksh -l {0}
        run: |
          command-exists -- dorothy
          echo-style --success='ok'
      - name: 'Trunk Format'
        if: github.event_name == 'push'
        shell: bash -leo pipefail {0}
        run: |
          dorothy format
          # commit changes, if any
          cd "$DOROTHY"
          if git diff --quiet &>/dev/null; then
            echo 'Already formatted.'
          else
            git config --global user.name 'Continuous Integration'
            git config --global user.email 'bot@bevry.me'
            git remote set-url origin 'https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}'
            git commit -a -m 'ci: adjustments'
            git push origin HEAD:${{ github.ref }}
          fi
      - name: 'Trunk Check'
        shell: bash -leo pipefail {0}
        run: dorothy check
  # https://github.com/actions/runner-images?tab=readme-ov-file#available-images
  runner-test:
    if: github.event_name == 'push' || ( github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) == 'false' && toJson(github.event.pull_request.state) == '"open"' && toJson(github.event.pull_request.assignees) != '[]' )
    strategy:
      fail-fast: false
      matrix:
        runner:
          - ubuntu-24.04
          - ubuntu-22.04
          - ubuntu-24.04-arm
          - ubuntu-22.04-arm
          - macos-15
          - macos-14
          - macos-13
    runs-on: ${{ matrix.runner }}
    steps:
      - name: 'Dorothy Test'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
        run: |
          # ensure dorothy is cloned, and run command
          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.event.pull_request.head.repo.full_name || github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test
  fresh-macos-test:
    if: github.event_name == 'push' || ( github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) == 'false' && toJson(github.event.pull_request.state) == '"open"' && toJson(github.event.pull_request.assignees) != '[]' )
    strategy:
      fail-fast: false
      matrix:
        runner:
          - macos-15
          - macos-14
          - macos-13
    runs-on: ${{ matrix.runner }}
    steps:
      - name: 'Uninstall Homebrew'
        run: |
          # run homebrew uninstaller
          bash -c "$(curl -fsSL 'https://raw.githubusercontent.com/Homebrew/install/master/uninstall.sh')"
      - name: 'Dorothy Test'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
        run: |
          # ensure dorothy is cloned, and run command
          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.event.pull_request.head.repo.full_name || github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test
  container-test:
    if: github.event_name == 'push' || ( github.event_name == 'pull_request' && toJson(github.event.pull_request.draft) == 'false' && toJson(github.event.pull_request.state) == '"open"' && toJson(github.event.pull_request.assignees) != '[]' )
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        container:
          - 'ubuntu:latest' # https://hub.docker.com/_/ubuntu
          - 'fedora:latest' # https://hub.docker.com/_/fedora
          - 'debian:latest' # https://hub.docker.com/_/debian
          - 'alpine:latest' # https://hub.docker.com/_/alpine <-- script -qec workaround for TTY does not work on alpine
          - 'opensuse/leap' # https://hub.docker.com/r/opensuse/leap <-- has outdated bash, so is good to test
          - 'opensuse/tumbleweed' # https://hub.docker.com/r/opensuse/tumbleweed
          - 'kalilinux/kali-rolling' # https://hub.docker.com/r/kalilinux/kali-rolling <-- apt based
          # - 'manjarolinux/base' # https://hub.docker.com/r/manjarolinux/base <-- broken due to https://gitlab.manjaro.org/packages/core/bash/-/issues/8 trying to remove it, trying to sync/refresh it, trying everything fails, as such disabled test, see all the failed CI attempts sinc: https://github.com/bevry/dorothy/actions/runs/7999660175/job/21847844816#step:3:84
          # - 'voidlinux/voidlinux' # https://hub.docker.com/r/voidlinux/voidlinux <-- locale failure, remote failure: https://github.com/bevry/dorothy/actions/runs/6622814794/job/17988863384
          # - 'mageia:cauldron' # https://hub.docker.com/_/mageia <-- cauldron is were moreutils is, disabled as couldn't get working
          # - 'nixos/nix' # https://hub.docker.com/r/nixos/nix <-- doesn't make bash available to env, also locale failure
          # - 'gentoo/stage3' # https://hub.docker.com/r/gentoo/stage3 <-- couldn't get to work due to home misconfigure error
    container:
      image: ${{ matrix.container }}
    steps:
      - name: 'Dorothy Dependencies'
        run: |
          # this should somewhat coincide with [commands/dorothy:ensure_prereq_dependencies]
          if command -v apt-get; then
            # for ubuntu/debian/kali
            apt-get update
            apt-get install -y bash curl
          elif command -v zypper; then
            # for opensuse
            zypper --non-interactive --gpg-auto-import-keys refresh
            zypper --non-interactive install bash curl
          elif command -v apk; then
            # for alpine
            apk update
            apk add bash curl
          elif command -v pacman; then
            # for manjaro (manjaro CI image doesn't have pamac installed) and arch
            pacman-key --init
            pacman --noconfirm --refresh --sync --needed bash curl
          elif command -v urpmi; then
            # for mageia, prefer over fedora as mageia also contains dnf
            # https://wiki.mageia.org/en/Cauldron
            # https://github.com/bevry/dorothy/actions/runs/6033044029/job/16369147940
            # https://github.com/bevry/dorothy/actions/runs/6033557632/job/16370418074
            # urpmi --auto-update --auto
            urpmi.update -a
            urpmi --auto bash curl
          elif command -v dnf; then
            # for fedora
            # dnf check-update --assumeyes
            # dnf upgrade --assumeyes --refresh --best --allowerasing
            dnf install --assumeyes --refresh --best --allowerasing bash curl
          elif command -v xbps-install; then
            # for void linux
            xbps-install --sync --update --yes xbps
            xbps-install --sync --yes bash curl
          elif command -v nix-env; then
            # for nix
            nix-env --install --attr nixpkgs.bash nixpkgs.curl
          elif command -v emerge; then
            # for gentoo
            emerge app-shells/bash net-misc/curl
          fi
      - name: 'Dorothy Remote Tests'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
        run: |
          # ensure dorothy is cloned, and run command
          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.event.pull_request.head.repo.full_name || github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test