CI #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright (C) 2022 Positron Solutions | |
| # Permission is hereby granted, free of charge, to any person obtaining a copy of | |
| # this software and associated documentation files (the "Software"), to deal in | |
| # the Software without restriction, including without limitation the rights to | |
| # use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | |
| # the Software, and to permit persons to whom the Software is furnished to do so, | |
| # subject to the following conditions: | |
| # The above copyright notice and this permission notice shall be included in all | |
| # copies or substantial portions of the Software. | |
| # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | |
| # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | |
| # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | |
| # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |
| # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| name: CI | |
| on: # trigger this workflow on | |
| push: | |
| branches: [ $default-branch ] # pushes to the default branch | |
| paths-ignore: | |
| - 'README.org' | |
| - 'CONTRIBUTING.org' | |
| pull_request_target: # or every pull request, from any branch to any branch | |
| paths-ignore: | |
| - 'README.org' | |
| - 'CONTRIBUTING.org' | |
| workflow_dispatch: | |
| # Allows you to run this workflow manually from the Actions tab | |
| jobs: | |
| continuous-integration: # just a job name | |
| # Run on every OS and Emacsen | |
| # Some steps switch logic on os or emacsPkg! | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| emacsPkg: [ emacs, emacs-git, ] | |
| runs-on: ${{ matrix.os }} | |
| # If you update steps, be sure to update the approved actions list in the | |
| # manual and in your repositories! | |
| steps: | |
| - uses: actions/[email protected] | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - uses: cachix/install-nix-action@v22 | |
| with: | |
| extra_nix_config: | | |
| access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} | |
| - uses: cachix/cachix-action@v12 | |
| with: | |
| # This CACHIX_AUTH_TOKEN & CACHIX_CACHE_NAME are secrets you must set | |
| # in your repository settings | |
| name: ${{ secrets.CACHIX_CACHE_NAME }} | |
| authToken: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| extraPullNames: nix-community # look for pre-built binaries from upstream | |
| # Some paths may confuse cachix. Add them with a pipe to the pushFilter | |
| pushFilter: "(.drv.chroot$)" | |
| # Loading the development shell with frozen versions is important to | |
| # verify that any flake commands will successfully run straight off of the | |
| # github repository. | |
| - name: load the shell with frozen versions | |
| run: nix develop .github#${{ matrix.emacsPkg }} --ignore-environment --command "emacs" "--version" | |
| # Linting the package is less useful on multiple version. Modify the | |
| # logic if you wish to expand lint coverage. | |
| - name: lint package | |
| if: matrix.emacsPkg == 'emacs' && matrix.os == 'ubuntu-latest' | |
| run: | | |
| eval "$(nix print-dev-env \ | |
| --override-input nixpkgs github:nixos/nixpkgs/release-22.11 \ | |
| --update-input emacs-overlay \ | |
| .github#${{ matrix.emacsPkg }})" | |
| # Lint the package | |
| # ⚠️ linting is quite screwed up for this package, likely because it contains | |
| # commented package headers in the source | |
| # emacs --script .github/run-shim.el -- lint | |
| # Lint the tests | |
| emacs --script .github/run-shim.el -- lint-tests | |
| - name: run tests | |
| run: | | |
| # First load the shell. Updating inputs will update the view of ELPA | |
| # Emacs git, and nixpkgs. | |
| # Possible RUNNER_OS values: Windows Linux MacOS | |
| # https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables | |
| # These eval "$(nix print-dev-env)" calls alter the shell. In a | |
| # non-interactive shell like CI, calling nix develop doesn't have the | |
| # same behavior. | |
| if [[ $RUNNER_OS == Linux ]]; then | |
| eval "$(nix print-dev-env \ | |
| --override-input nixpkgs github:nixos/nixpkgs/release-22.11 \ | |
| --update-input emacs-overlay \ | |
| .github#${{ matrix.emacsPkg }})" | |
| else | |
| eval "$(nix print-dev-env \ | |
| --override-input nixpkgs github:nixos/nixpkgs/nixpkgs-22.11-darwin \ | |
| --update-input emacs-overlay \ | |
| .github#${{ matrix.emacsPkg }})" | |
| fi | |
| # Runs the tests in a graphical window (can freeze) | |
| # emacs --quick --load .github/run-shim.el -- test $GITHUB_SHA | |
| # Run tests with terminal output and no graphical window | |
| emacs --script .github/run-shim.el -- test $GITHUB_SHA |