Externalise cache keys to prevent unneeded invalidation by pljones · Pull Request #3922 · jamulussoftware/jamulus

pljones · 2026-08-22T14:11:33Z

Short description of changes

I noticed whilst I've been working on autobuild.sh that every change invalidates all the caches. Because autobuild.sh itself is included in the cache key calculation. This change replaces that mechanism on macOS and Windows with am externalised list of dependencies. It adds the same mechanism to iOS, which lacked caching.

Github cache clean up will remove unused cache entries with no need to have the cache consumer included in the cache key.

(My work in progress on the Android build uses the same approach, which is where this comes from.)

Scope, guidance, testing and review by myself, coding my VSCode Github CoPilot.

CHANGELOG: Build: improve cache persistence

Context: Fixes an issue?

Caching should depend on what is being cached, rather than the cache consumer.

Does this change need documentation? What needs to be documented and how?

No.

Status of this Pull Request

Tested against the current branch in my own repository before raising the PR here.

What is missing until this pull request can be merged?

Need to do some more testing.

Checklist

I've verified that this Pull Request follows the general code principles
I tested my code and it does what I want
My code follows the style guide
I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
I've filled all the content above

AUTOBUILD: Please build all targets

softins

Looks ok in general, just a couple of comments.

pljones · 2026-08-25T20:11:48Z

Well, it's not quite there, is it....

mcfnord · 2026-08-25T22:17:12Z

🤖 AI: The four former param() defaults at deploy_windows.ps1 kept their trailing commas and deploy_mac.sh kept the ../.. that suits a script one level deeper, and two more sit behind that Windows parse error: the launch line still passes the two Qt paths positionally to a param() that no longer declares them, and $QtCompile64 is now msvc2022 while the aqt arch is still win64_${QtCompile64}_64.

pljones · 2026-08-28T17:44:13Z

Getting there -- the caches are being made and restored. Windows and macOS don't realise this - they go off and install again...

iOS gets it right.

Cache hit for: ios-0f7a19096b2d214a9d0ef45f70b89972b1f10eec3e4f6ae85a49f4dbcf9925d3-ios

Using Qt installation from previous run (actions/cache)

Bump dependencies is working, too.

pljones · 2026-08-29T15:47:09Z

Right - all tests now passing:

Cache keys created for iOS, macOS qt5, macOS qt6, Windows ASIO, Windows Jack
Caches populated on successful completion for each key
Caches restored on subsequent run on same branch (that's just how the cache works)
Caches used by the matrix setup runner
Bump Dependencies correctly spots version matches and mismatches
- One caveat: as we currently have divergent macOS and Windows Qt6 versions, it raises one PR to bring them together
- I've only checked the diff for the PR its created - pljones@812e9d7

ann0see · 2026-08-31T20:34:28Z

@@ -0,0 +1,6 @@
+#!/bin/bash
+


This then dropped the comment about pinning?

ann0see · 2026-08-31T20:36:26Z

+PROJECT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
+readonly PROJECT_DIR
+# shellcheck disable=SC1090
+source "${PROJECT_DIR}/.github/autobuild/mac-dependencies_qt${QT}.sh"


Do we have a guarantee that ${QT} is safe and correct? I'd add an error check if the file exists before.

It's set from the autobuild workflow file and, if not, defaults to 6 at the top of the file. If someone sets the wrong value, this command will safely crash the workflow.

I'd still like a guard to reject invalid values.

ann0see · 2026-08-31T20:37:01Z

+# Important:
+# - Do not update ASIO SDK without checking for license-related changes.
+# - Do not copy (parts of) the ASIO SDK into the Jamulus source tree without
+#   further consideration as it would make the license situation more complicated.


Probably outdated as they moved to the GPL.

As it's version dependent (if the old version can still be found), I suppose it makes sense to keep it. If and when the old version vanishes, this can go, too.

The old version will probably not vanish. But we can of course keep this.

ann0see · 2026-08-31T20:40:34Z

I think we might have an issue about some OS not being cached. Worth checking the issues for that and linking it here. If the issue is iOS related, we can close it.

ann0see · 2026-09-01T17:07:07Z

The iOS caching issue was already documented. Thus:

Fixes: #2462

ann0see · 2026-09-01T17:10:34Z

-# The following version pinnings are semi-automatically checked for
-# updates. Verify .github/workflows/bump-dependencies.yaml when changing those manually:


@pljones Maybe I am blind, but I think this comment got dropped?

Oh, right. I should have put that on all the *-dependencies*.

pljones self-assigned this Aug 22, 2026

pljones added tooling Changes to the automated build system AI AI generated or potentially AI generated labels Aug 22, 2026

pljones added this to Tracking Aug 22, 2026

github-project-automation Bot moved this to Triage in Tracking Aug 22, 2026

pljones moved this from Triage to Waiting on Team in Tracking Aug 22, 2026

mcfnord reviewed Aug 22, 2026

View reviewed changes

Comment thread .github/workflows/autobuild.yml Outdated

pljones force-pushed the cache-keys branch 4 times, most recently from fdae3db to 4b51804 Compare August 23, 2026 17:39

softins reviewed Aug 24, 2026

View reviewed changes

Comment thread .github/workflows/autobuild.yml Outdated

Comment thread .github/workflows/bump-dependencies.yml Outdated

Comment thread .github/workflows/bump-dependencies.yml Outdated

pljones force-pushed the cache-keys branch 11 times, most recently from 73de281 to 3f7be01 Compare August 25, 2026 20:08

pljones marked this pull request as draft August 25, 2026 20:11

ann0see self-requested a review August 25, 2026 21:25

pljones force-pushed the cache-keys branch 3 times, most recently from 48e4892 to 081b45d Compare August 26, 2026 17:05

pljones force-pushed the cache-keys branch 12 times, most recently from 54278a8 to d364a54 Compare August 28, 2026 17:29

pljones force-pushed the cache-keys branch 3 times, most recently from d7b1d7b to c411a51 Compare August 29, 2026 15:31

pljones marked this pull request as ready for review August 29, 2026 15:47

pljones force-pushed the cache-keys branch from c411a51 to e04a8f9 Compare August 31, 2026 15:50

ann0see reviewed Aug 31, 2026

View reviewed changes

pljones force-pushed the cache-keys branch from e04a8f9 to b20d7e5 Compare September 1, 2026 17:03

pljones added this to the Release 4.0.0 milestone Sep 1, 2026

ann0see reviewed Sep 1, 2026

View reviewed changes

pljones linked an issue Sep 1, 2026 that may be closed by this pull request

Add caching for iOS build #2462

Open

Externalise cache keys to prevent unneeded invalidation

79e0c1e

pljones force-pushed the cache-keys branch from b20d7e5 to 79e0c1e Compare September 1, 2026 17:16

		# The following version pinnings are semi-automatically checked for
		# updates. Verify .github/workflows/bump-dependencies.yaml when changing those manually:

Uh oh!

Conversation

pljones commented Aug 22, 2026

Checklist

Uh oh!

Uh oh!

softins left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pljones commented Aug 25, 2026

Uh oh!

mcfnord commented Aug 25, 2026

Uh oh!

pljones commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pljones commented Aug 29, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ann0see commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ann0see commented Sep 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pljones Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pljones commented Aug 28, 2026 •

edited

Loading

ann0see commented Aug 31, 2026 •

edited

Loading

pljones Sep 1, 2026 •

edited

Loading