Skip to content

Commit 97acd19

Browse files
authored
Merge pull request #340 from ShimmerResearch/DEV-1358_matlab_release_note
DEV-1358: MATLAB update PR asks for a hardware check and says merging releases
2 parents ee43fbd + 6258455 commit 97acd19

2 files changed

Lines changed: 12 additions & 7 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
# gives a Jira key (the waiver goes into the release notes). Dry runs only warn.
77
# 1. Actions -> "Release Java API" -> Run workflow (on master). Leave `version` blank for the next
88
# patch after the last API_v release (0.11.8_beta -> 0.11.9_beta), or type one.
9-
# 2. Review and merge the ShimmerJavaClass.jar PR it opens in Shimmer-MATLAB-ID.
9+
# 2. Run a MATLAB example on a Shimmer3 and a Shimmer3R with the ShimmerJavaClass.jar PR it opens in
10+
# Shimmer-MATLAB-ID, then merge it. Merging publishes a MATLAB API release (that repo's release.yml).
1011
# 3. Run "Release Android API" in ShimmerAndroidAPI, which builds against this version by default.
1112
#
1213
# The version is not kept in the source. The build files read it from -PreleaseVersion, which this
@@ -24,9 +25,9 @@
2425
# release tags API_v<version> on the commit it built and creates the GitHub Release, with
2526
# notes from the previous API_v release and the jars attached. It is not marked
2627
# "Latest", which stays with the Consensys releases in this repo.
27-
# update-matlab opens a PR in Shimmer-MATLAB-ID replacing libs/ShimmerJavaClass.jar. Needs the
28-
# MATLAB_REPO_TOKEN secret: a fine-grained token for ShimmerResearch/Shimmer-MATLAB-ID
29-
# with Contents and Pull requests read/write.
28+
# update-matlab opens a PR in Shimmer-MATLAB-ID replacing libs/ShimmerJavaClass.jar; merging it
29+
# publishes a MATLAB API release. Needs the MATLAB_REPO_TOKEN secret: a fine-grained
30+
# token for ShimmerResearch/Shimmer-MATLAB-ID with Contents and Pull requests read/write.
3031
#
3132
# A failed job can be re-run on its own with "Re-run failed jobs"; the jobs before it are not
3233
# repeated. A failed publish can leave some of the three versions in GitHub Packages: delete those
@@ -346,7 +347,7 @@ jobs:
346347
echo "- Release: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/tag/$TAG"
347348
echo "- Packages: com.shimmerresearch:shimmerdriver, shimmerbluetoothmanager and shimmerdriverpc at $VERSION"
348349
echo "- ${HIL:-No hardware test result}"
349-
echo "- Next: merge the MATLAB PR, then run Release Android API in ShimmerAndroidAPI; it builds against $VERSION unless you pick another driver version."
350+
echo "- Next: run a MATLAB example on a Shimmer3 and a Shimmer3R and merge the MATLAB PR, which publishes a MATLAB API release; then run Release Android API in ShimmerAndroidAPI; it builds against $VERSION unless you pick another driver version."
350351
} >> "$GITHUB_STEP_SUMMARY"
351352
352353
update-matlab:
@@ -407,6 +408,9 @@ jobs:
407408
--title "Update ShimmerJavaClass.jar to Shimmer Java API $VERSION" \
408409
--body "Replaces \`libs/ShimmerJavaClass.jar\` with the build from [$TAG]($GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/tag/$TAG) (\`$GITHUB_SHA\`), compiled as Java 8 bytecode with \`gradlew shadowJar -PmatlabJava8\`.
409410
411+
- Before merging, run an example such as \`plotandwriteexample.m\` on a Shimmer3 and a Shimmer3R. MATLAB cannot run in CI.
412+
- Merging publishes a MATLAB API release: the next patch version, with Java API $VERSION in its title.
413+
410414
Opened by the [Release Java API run]($GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID).")
411415
echo "Opened $url"
412416
echo "- MATLAB PR: $url" >> "$GITHUB_STEP_SUMMARY"

‎AGENTS.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ and need no uprev PR:
2626
Packages in one `gradlew publish`, tags `API_v<version>`, and creates the GitHub Release with the
2727
jars attached (not marked Latest — that stays with Consensys).
2828
2. It also builds `ShimmerJavaClass.jar` for MATLAB and opens a PR replacing
29-
`Shimmer-MATLAB-ID/libs/ShimmerJavaClass.jar` (needs the `MATLAB_REPO_TOKEN` secret). Review and
30-
merge it.
29+
`Shimmer-MATLAB-ID/libs/ShimmerJavaClass.jar` (needs the `MATLAB_REPO_TOKEN` secret). Before
30+
merging it, run a MATLAB example on a Shimmer3 and a Shimmer3R; MATLAB cannot run in CI. Merging
31+
publishes a MATLAB API release (Shimmer-MATLAB-ID's `release.yml`).
3132
3. Run `ShimmerAndroidAPI`'s own Release workflow, which builds against the newest Java release unless
3233
told otherwise.
3334

0 commit comments

Comments
 (0)