Clojure(script) CI

Ci integration
Github

Ci integration

Building a polylith based clojure project, these steps are similar to most clojure projects with a few additions for the poly tool.

Github

Deploy rules

Name our action and run it only when code is pushed into master

name: Staging Deploy
on:
  push:
    branches: [master]

Checkout

Checkout repository, fetch depth is required if you needs tags available

     # Checkout the code
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0

Cache

Cache the downloaded libraries so we don't do each each time.

      # Cache project dependencies
      - name: Cache deps
        uses: actions/cache@v2
        with:
          path: |
            ~/.polylith
            ~/.m2
            ~/.gitlibs
            ~/.clojure            
          key: ${{ runner.os }}-maven-${{ hashFiles('deps.edn') }}
          restore-keys: |
            ${{ runner.os }}-maven-
            ${{ runner.os }}-

Set env / project checks

Create a var called CHANGED_PROJECTS we can use in conditionals in later build steps, we also check our project comply's to the polylith rules before moving onto linting, testing, building and deploying.

      # Check the project and set enc for later steps
      - name: Poly Check / Set Env
        run: |-
          cd workspace
          echo "CHANGED_PROJECTS=$(clojure -M:poly ws get:changes:changed-or-affected-projects since:previous-release skip:dev)" >> $GITHUB_ENV
          clojure -M:poly info since:release
          clojure -M:poly check

Setup Java

Install a version on java using the java action.

      # Install java
      - name: Set up JDK & publish to maven
        uses: actions/setup-java@v1
        with:
          java-version: 13

Setup clojure

Install clojure from the clojure action.

      # Install clojure
      - name: Install clojure tools
        uses: DeLaGuardo/setup-clojure@3.5
        with:
          cli: 1.10.3.933

Linting

Lint code with clj-kondo this example lints src and workspace folders.

      # Lint the code with kondo
      - name: Code Linting
        uses: DeLaGuardo/clojure-lint-action@master
        with:
          clj-kondo-args: --lint src workspace
          check-name: Linting
          github_token: ${{ secrets.GITHUB_TOKEN }}

Testing changes since last release

Run test but only test since the last tagged release

    # Run the tests
    - name: Poly Test
      run: |-
        cd workspace
        clojure -M:poly test since:previous-release

Building

Finally create your uberjar, this example uses a condition so it only builds if the projects or one of its components has changed. We need to set the env in a previous step to make it available to future steps.

    # Build the uberjar
    - name: Build my example api
      if: contains('${{ env.CHANGED_PROJECTS }}', 'my-example-api')
      run: |-
        cd  workspace/projects/my-example-api
        clojure -X:uberjar

3.5 KiB Raw Blame History