Repository navigation
DEV-1359: a Java API release opens a driver-bump PR in ShimmerAndroidAPI - #341
Merged
Merged
Conversation
New job update-android, modelled on update-matlab: on a real release, after the release job, it moves the default driver version in ShimmerAndroidAPI's ShimmerAndroidInstrumentDriver/build.gradle to the new one on a driver_<version> branch and opens a PR. The PR lists the steps that stay manual: check the driver changes since the last pin for parser, CRC or ACK fixes to port to Shimmer.java, run the Android HIL at master's new commit after merging, then run Release Android API. It skips if master is already on that version or the branch or PR exists, and links the PR in the step summary. Needs a new secret, ANDROID_REPO_TOKEN: a fine-grained token for ShimmerResearch/ShimmerAndroidAPI with Contents and Pull requests read/write. Without it the job stops with an error, as update-matlab does. How to release step 3, the run summary's Next line and AGENTS.md now describe the Android steps. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
After a Java API release, MATLAB is already automated:
update-matlabopens the jar PR, and merging it publishes a MATLAB release. Android was not. Nothing happened in ShimmerAndroidAPI until someone ran its HIL and then Release Android API, and its default driver pin was bumped by hand.The Android release stays manual, because its gate needs a passing bench HIL on the exact commit and driver. This PR adds the step that can be automated, so Android shows up in the Java release run.
update-android, modelled onupdate-matlab. It runs on real releases only, afterrelease, and is skipped on dry runs and PRs. It:ANDROID_REPO_TOKEN. If that secret is missing, it stops with an::error::naming it.findProperty('driverVersion') ?: '<old>'inShimmerAndroidInstrumentDriver/build.gradleto the new version, on branchdriver_<version>.API_v<old>...API_v<new>) contain no parser, CRC or ACK fixes that need porting toShimmer.java. After merging:tools/hil/run-android-hil.ps1 -Report -DriverVersion <version>at master's new commit, then Release Android API.AGENTS.mdnow describe the Android steps.What you need to add
ANDROID_REPO_TOKENin this repo: a fine-grained token with resource owner ShimmerResearch, repository ShimmerAndroidAPI only, and Contents and Pull requests set to read/write. Without it,update-androidfails once the release is already out: add the secret, then "Re-run failed jobs".Tested
bash -eo pipefailas Actions runs it. It ran against a scratch repo holding ShimmerAndroidAPI master'sbuild.gradle, with a local bare repo as origin and a stubgh. Six cases:driver_0.11.12_beta, opens the PR (body checked as rendered) and writes the summary line.buildandmatlab-jar.update-androidis skipped there, asupdate-matlabis.Only testable at the next real release
The job runs only on a real release. So the real token, the cross-repo checkout and push,
gh pr createagainst GitHub, and the ShimmerAndroidAPI CI run the PR starts are all first exercised then. A PR opened with a PAT starts workflows; GitHub suppresses that only forGITHUB_TOKEN.Known consequence
The next Java release will include DEV-1337 (#339). On its bump PR, AAPI_00002, AAPI_00003 and AAPI_00005 will fail until they are adapted, because they expect
startSDLogging()on a streaming Shimmer3R to queueSET_RWC. That is the same change #339 made to API_00027, API_00030 and API_00032. Neither PR changes those tests.Companion
ShimmerResearch/ShimmerAndroidAPI#141 adds the library's unit tests to that repo's CI. Without it, a bump PR would only build.
Sibling APIs: this is release tooling, not wire format, so no other host API needs it.
🤖 Generated with Claude Code