Please document how to cache so that bb is not re-downloaded on each run

[holyjak]

I see that every run of the setup action, bb is downloaded anew. It should be possible to cache it.

Actually looking at DeLaGuardo/[email protected] it seems it does cache it itself:

Run DeLaGuardo/[email protected]
...
Cache restored successfully
Clojure CLI found in cache /opt/hostedtoolcache/ClojureToolsDeps/1.11.1-1208-10-1/x64

so perhaps setup-babashka could do the same? 🙏

[nha]

setup-babashka should also use the cache if available.
See:

• the code

  setup-babashka/src/installer.ts

  Lines 113 to 119 in 1e886ef

  	toolPath = await tc.cacheFile(
  	executable,
  	executable,
  	'Babashka',
  	version, // semver, should end with -SNAPSHOT here
  	os.arch()
  	)

  and

  setup-babashka/src/installer.ts

  Lines 132 to 140 in 1e886ef

  	let toolPath = tc.find('Babashka', version, os.arch())
  	const allBabashkaVersions = tc.findAllVersions('Babashka')
  	if (allBabashkaVersions.length != 0) {
  	core.info(`Versions of babashka available: ${allBabashkaVersions}`)
  	} else {
  	core.info(`No versions of babashka are available yet`)
  	}

• the test

  setup-babashka/.github/workflows/self_check.yml

  Lines 22 to 26 in 1e886ef

  	- name: Setup Babashka from cache
  	id: setup-babashka-2
  	uses: turtlequeue/setup-babashka@main
  	with:
  	babashka-version: ${{ matrix.babashka-version }}

• one example run: https://github.com/turtlequeue/setup-babashka/actions/runs/4025693631/jobs/6919247271#step:4:7

Is there an indication that this is not working as expected?

[liny01-nbsa]

Hi @nha , Below log is from one of our actions, and it's been running for weeks. And this is from its latest run

Looks, it couldn't find any cached version, and downloads bb.

This is the part of action

      - name: Install babashka v1.3.188
        uses: turtlequeue/[email protected]
        with:
          babashka-version: '1.3.188'

[liny01-nbsa]

@nha , I use the below snippet to workaround, it looks to work, is it possible that the issue is Windows only?

      - name: Cache Babashka binary (Workaround)
        uses: actions/cache@v4
        id: cache-bb
        with:
          # save-always: true
          path: C:\hostedtoolcache\windows\Babashka\1.3.188\x64
          key: ${{ runner.os }}-bb-1.3.188

      - name: Install babashka v1.3.188
        if: steps.cache-bb.outputs.cache-hit != 'true'
        uses: turtlequeue/[email protected]
        with:
          babashka-version: '1.3.188'

      - name: add bb to path
        if: steps.cache-bb.outputs.cache-hit == 'true'
        run: echo "C:\hostedtoolcache\windows\Babashka\1.3.188\x64" >> $env:GITHUB_PATH

[nha]

@liny01-nbsa Thank you for the report, I will look into it. While I do not use Windows myself, it should work all the same.
Do I understand correctly that you are using the self-hosted github runner?

[liny01-nbsa]

@nha , no, we are using the hosted runner. windows-latest.

[nha]

Please give a try to v1.7.0.

I should also mention that I am not convinced if caching makes a practical difference here because it usually takes about 3 seconds to run the action without caching.

[liny01-nbsa]

@nha , thank you! That is a very interesting point. I don't have access to my workstation now. But from my screenshot, I noticed in about Jan 2024, a non-cached run would take > 1 min.

I will test the new version when I got back.

[nha]

Oh interesting. Here is a sample run from the main branch on windows, it took 3s:

https://github.com/turtlequeue/setup-babashka/actions/runs/8510483088/job/23308162033