|
6 | 6 | # gives a Jira key (the waiver goes into the release notes). Dry runs only warn. |
7 | 7 | # 1. Actions -> "Release Java API" -> Run workflow (on master). Leave `version` blank for the next |
8 | 8 | # 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). |
10 | 11 | # 3. Run "Release Android API" in ShimmerAndroidAPI, which builds against this version by default. |
11 | 12 | # |
12 | 13 | # The version is not kept in the source. The build files read it from -PreleaseVersion, which this |
|
24 | 25 | # release tags API_v<version> on the commit it built and creates the GitHub Release, with |
25 | 26 | # notes from the previous API_v release and the jars attached. It is not marked |
26 | 27 | # "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. |
30 | 31 | # |
31 | 32 | # A failed job can be re-run on its own with "Re-run failed jobs"; the jobs before it are not |
32 | 33 | # repeated. A failed publish can leave some of the three versions in GitHub Packages: delete those |
@@ -346,7 +347,7 @@ jobs: |
346 | 347 | echo "- Release: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/tag/$TAG" |
347 | 348 | echo "- Packages: com.shimmerresearch:shimmerdriver, shimmerbluetoothmanager and shimmerdriverpc at $VERSION" |
348 | 349 | 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." |
350 | 351 | } >> "$GITHUB_STEP_SUMMARY" |
351 | 352 |
|
352 | 353 | update-matlab: |
@@ -407,6 +408,9 @@ jobs: |
407 | 408 | --title "Update ShimmerJavaClass.jar to Shimmer Java API $VERSION" \ |
408 | 409 | --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\`. |
409 | 410 |
|
| 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 | +
|
410 | 414 | Opened by the [Release Java API run]($GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID).") |
411 | 415 | echo "Opened $url" |
412 | 416 | echo "- MATLAB PR: $url" >> "$GITHUB_STEP_SUMMARY" |
0 commit comments