# The main hledger continuous integration tests. # Code must pass this successfully before it can be merged or pushed to master. # https://github.com/simonmichael/hledger/settings/branch_protection_rules/17386787 # TRIGGER: Runs on any push to ci branch or any pull request against master. # ACTION: Builds, tests and saves linux x64 dynamic binaries with stack and the default ghc. name: ci on: # When manually triggered in github ui, it runs in master. workflow_dispatch: # When there's a push to the ci branch, it runs in that branch. # After it passes, those commits can be merged/pushed to master. # (Don't use these branches for pull requests, or it will run twice, # https://github.community/t/how-to-trigger-an-action-on-push-or-pull-request-but-not-both/16662/2) push: branches: [ ci ] # When there's a pull request against master, it runs in the pull request's branch. # After it passes, that branch can be merged/pushed to master. pull_request: branches: [ master ] # Uncomment to run it only for changes to these paths: (but that could prevent merging) # paths: # - '.github/workflows/pushpull.yml' # - 'stack*.yaml' # - 'hledger-lib/**' # - 'hledger/**' # - 'hledger-ui/**' # - 'hledger-web/**' # - 'bin/*.hs' # - 'examples/**' # Or to ignore certain paths: # # examples # - '!**.journal' # - '!**.j' # - '!**.ledger' # - '!**.csv' # # docs # - '!**.m4' # - '!**.md' # - '!**.1' # - '!**.5' # - '!**.info' # - '!**.txt' jobs: ci: runs-on: ubuntu-24.04 env: # This workflow uses github's preinstalled ghc & stack on ubuntu. # Keep these synced with the latest ghc version at https://github.com/actions/runner-images/blob/ubuntu22/20240514.2/images/ubuntu/Ubuntu2404-Readme.md#haskell-tools # # caching id for this ghc's build artifacts: # XXX ideally should match the default ghc in stack.yaml, though it's not critical # XXX supposed to be interpolated by $ghc below, but this is not working ghc: 910 # stack config for this ghc: stack: stack --system-ghc # flag for skipping later steps, declared here to prevent "Context access might be invalid" warnings do-all: steps: - name: Check out uses: actions/checkout@v4 # have to fetch everything for git describe for hledger's --version with: fetch-depth: 0 # - name: Print some context for troubleshooting # env: # GITHUB_CONTEXT: ${{ toJson(github) }} # run: | # echo $GITHUB_CONTEXT # # echo "$GITHUB_SHA" # # echo "$GITHUB_REF" # # echo "$GITHUB_HEAD_REF" # # echo "$GITHUB_BASE_REF" # # git log "$GITHUB_BASE_REF".. # # tools/commitlint "$GITHUB_BASE_REF".. # EARLY ACTIONS - name: Check commit messages # keep this step synced in all workflows which do it # For a PR, the range will be: master..origin/$GITHUB_HEAD_REF # For a push it will be: $BEFORE.. # For a force push, BEFORE is the previous HEAD, and on github (though not locally) this is an "invalid revision range". # 202310: we skip this check when we can't detect the commits, which happens in certain cases # related: https://stackoverflow.com/questions/64708371/how-to-run-github-workflow-on-every-commit-of-a-push # 202312: ignore this if it fails, it may be not worth the hassle env: BEFORE: ${{ github.event.before }} # NUM: 5 shell: bash run: | RANGE=${BEFORE:-origin/master}..${GITHUB_HEAD_REF:-} echo "debug: last 10 commits:" echo "$(git log --format='%h -%d %s (%an, %ci)' -10)" echo "debug: origin/master:" echo "$(git log --format='%h -%d %s (%an, %ci)' -1 origin/master)" echo "debug: BEFORE=$BEFORE" echo "$(git log --format='%h -%d %s (%an, %ci)' -1 $BEFORE)" echo "debug: GITHUB_HEAD_REF=$GITHUB_HEAD_REF" echo "$(git log --format='%h -%d %s (%an, %ci)' -1 $GITHUB_HEAD_REF)" echo "debug: RANGE=$RANGE" echo "debug: commits to check:" echo "$(git log --format='%h -%d %s (%an, %ci)' --abbrev-commit --date=relative --date-order $RANGE)" if git rev-list --quiet $RANGE then tools/commitlint $RANGE || echo "commit lint failed, ignoring" else # echo "could not identify commits, checking last $NUM instead:"; tools/commitlint -$NUM echo "could not identify commits, not checking them" # XXX fi - name: Skip remaining steps if the last commit message begins with ; shell: bash run: | echo "git log -1 --pretty='%s' ${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF} >> $$.gitlog" (git log -1 --pretty='%s' ${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF} >> $$.gitlog \ && (grep -qE '^ *;' $$.gitlog || echo "do-all=true" >> $GITHUB_ENV)) \ || ( echo "could not identify commit range, continuing CI steps"; echo "do-all=true" >> $GITHUB_ENV ) # Can't uncache to /usr/bin: # /usr/bin/tar -xf /home/runner/work/_temp/5cef703c-9831-41db-adb3-470b839f8a0e/cache.tzst -P -C /home/runner/work/hledger/hledger --use-compress-program unzstd # /usr/bin/tar: ../../../../../usr/bin/rg: Cannot open: Permission denied # - name: Cache - extra tools (ripgrep) in /usr/bin # id: extratools # uses: actions/cache@v4 # with: # path: /usr/bin/rg # key: ${{ runner.os }}-extratools # should have image version in there too # if: env.do-all - name: Check embedded files run: | if [[ ! -x /usr/bin/rg ]]; then sudo apt install -y ripgrep; fi tools/checkembeddedfiles if: env.do-all # CACHES - name: Cache - stack global package db id: stack-global uses: actions/cache@v4 with: path: ~/.stack # XXX if stack.yaml is a symlink, this fails with # Error: The template is not valid. .github/workflows/push.yml (Line: 103, Col: 14): hashFiles('**.yaml') failed. # Fail to hash files under directory '/home/runner/work/hledger/hledger' key: ${{ runner.os }}-stack-global-$ghc-${{ hashFiles('**.yaml') }} restore-keys: | ${{ runner.os }}-stack-global-$ghc if: env.do-all - name: Cache - stack-installed programs in ~/.local/bin id: stack-programs uses: actions/cache@v4 with: path: ~/.local/bin key: ${{ runner.os }}-stack-programs-$ghc-${{ hashFiles('**.yaml') }} restore-keys: | ${{ runner.os }}-stack-programs-$ghc if: env.do-all - name: Cache - .stack-work uses: actions/cache@v4 with: path: .stack-work key: ${{ runner.os }}-stack-work-$ghc-${{ hashFiles('**.yaml') }} restore-keys: | ${{ runner.os }}-stack-work-$ghc if: env.do-all - name: Cache - hledger-lib/.stack-work uses: actions/cache@v4 with: path: hledger-lib/.stack-work key: ${{ runner.os }}-hledger-lib-stack-work-$ghc-${{ hashFiles('hledger-lib/package.yaml') }} restore-keys: | ${{ runner.os }}-hledger-lib-stack-work-$ghc if: env.do-all - name: Cache - hledger/.stack-work uses: actions/cache@v4 with: path: hledger/.stack-work key: ${{ runner.os }}-hledger-stack-work-$ghc-${{ hashFiles('hledger/package.yaml') }} restore-keys: | ${{ runner.os }}-hledger-stack-work-$ghc if: env.do-all - name: Cache - hledger-ui/.stack-work uses: actions/cache@v4 with: path: hledger-ui/.stack-work key: ${{ runner.os }}-hledger-ui-stack-work-$ghc-${{ hashFiles('hledger-ui/package.yaml') }} restore-keys: | ${{ runner.os }}-hledger-ui-stack-work-$ghc if: env.do-all - name: Cache - hledger-web/.stack-work uses: actions/cache@v4 with: path: hledger-web/.stack-work key: ${{ runner.os }}-hledger-web-stack-work-$ghc-${{ hashFiles('hledger-web/package.yaml') }} restore-keys: | ${{ runner.os }}-hledger-web-stack-work-$ghc if: env.do-all # ACTIONS # in modular steps for faster & more focussed failures # XXX slow, I feel this should happen less often - name: Update package index run: | $stack update if: env.do-all - name: Build deps of hledger-lib run: | $stack build --test --bench hledger-lib --only-dependencies if: env.do-all - name: Build/test hledger-lib run: | $stack install --test --bench hledger-lib --fast --ghc-options=-Werror if: env.do-all - name: Build deps of hledger run: | $stack build --test --bench hledger --only-dependencies if: env.do-all - name: Build/test hledger run: | $stack install --test --bench hledger --fast --ghc-options=-Werror if: env.do-all - name: Build deps of hledger-ui run: | $stack build --test --bench hledger-ui --only-dependencies if: env.do-all - name: Build/test hledger-ui run: | $stack install --test --bench hledger-ui --fast --ghc-options=-Werror if: env.do-all - name: Build deps of hledger-web run: | $stack build --test --bench hledger-web --only-dependencies if: env.do-all - name: Build/test hledger-web run: | $stack install --test --bench hledger-web --fast --ghc-options=-Werror if: env.do-all - name: Install shelltestrunner run: | export PATH=~/.local/bin:$PATH if [[ ! -x ~/.local/bin/shelltest ]]; then $stack install shelltestrunner-1.10; fi shelltest --version if: env.do-all # Takes ~30s on a 2023 github worker. - name: Test functional tests (excluding addons) run: | export PATH=~/.local/bin:$PATH COLUMNS=80 $stack exec -- shelltest --execdir -j16 hledger/test -x /_ -x /addons -x ledger-compat/ledger-baseline -x ledger-compat/ledger-regress -x ledger-compat/ledger-collected # XXX run the bin/ func tests corresponding to the GHC version enabled above, only if: env.do-all # Takes 1m+ on a 2023 github worker. # Moved to binaries-mac-arm64 workflow instead; # haddock breakage might not be found until release time but it's easy to fix. # - name: Test haddock generation # env: # stack: ${{ matrix.plan.stack }} # run: | # printf "haddock version: "; haddock --version # time $stack build --fast --haddock --no-haddock-deps --no-haddock-hyperlink-source --haddock-arguments="--no-print-missing-docs" || echo "HADDOCK FAILED, IGNORING" # # --no-haddock-hyperlink-source is 25% faster # # --no-print-missing-docs is 600% quieter # if: env.do-all # ARTIFACTS - name: Gather binaries id: exes run: | mkdir tmp cd tmp cp -P ~/.local/bin/hledger . cp -P ~/.local/bin/hledger-ui . cp -P ~/.local/bin/hledger-web . strip hledger strip hledger-ui strip hledger-web tar cvf hledger-linux-x64.tar hledger hledger-ui hledger-web if: env.do-all # upload-artifact loses execute permissions, so we tar the binaries to preserve them. # github UI always zips artifacts when they are downloaded, so we don't bother compressing the tar. # Unfortunately it means users must both unzip and untar. - name: Upload binaries uses: actions/upload-artifact@v4 with: name: hledger-linux-x64 path: tmp/hledger-linux-x64.tar if: env.do-all # SNIPPETS # how to set a context variable, and an attempt to make a nice artifact version suffix: # echo "::set-output name=version::$(git branch --show-current | sed 's/-.*//')-$(git rev-parse --short HEAD)" # - name: show stuff # run: | # if [[ -e ~/.local/bin ]]; then ls -lFRa ~/.local/bin; fi # inspect available context info, per # https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions. # sample output: https://github.com/simonmichael/hledger/runs/1619227104 # - name: Dump GitHub context # env: # GITHUB_CONTEXT: ${{ toJson(github) }} # run: echo "$GITHUB_CONTEXT" # - name: Dump job context # env: # JOB_CONTEXT: ${{ toJson(job) }} # run: echo "$JOB_CONTEXT" # - name: Dump steps context # env: # STEPS_CONTEXT: ${{ toJson(steps) }} # run: echo "$STEPS_CONTEXT" # - name: Dump runner context # env: # RUNNER_CONTEXT: ${{ toJson(runner) }} # run: echo "$RUNNER_CONTEXT" # - name: Dump strategy context # env: # STRATEGY_CONTEXT: ${{ toJson(strategy) }} # run: echo "$STRATEGY_CONTEXT" # - name: Dump matrix context # env: # MATRIX_CONTEXT: ${{ toJson(matrix) }} # run: echo "$MATRIX_CONTEXT"