Skip to content

Commit 5bfc241

Browse files
committed
Update release instructions to detail new Bump version Github workflow.
1 parent f37e2a5 commit 5bfc241

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -511,14 +511,20 @@ includeBuild('../rust-android-gradle') {
511511

512512
# Publishing
513513

514-
## Automatically via the release Github workflow
515-
516-
You will need to be a collaborator. First, push a preparatory commit updating version numbers and
517-
the changelog like [this
518-
one](https://github.com/mozilla/rust-android-gradle/commit/2a637d1797a5d0b5063b8d2f0a3d4a4938511154).
519-
Second, make a new Github Release with a name like `v0.8.4`. The release Github workflow will build
520-
and publish the plugin, although it may take some days for it to be reflected on the Gradle plugin
521-
portal.
514+
## Automatically via the Bump version Github Actions workflow
515+
516+
You will need to be a collaborator. First, manually invoke the [Bump version Github Actions
517+
workflow](https://github.com/mozilla/rust-android-gradle/actions/workflows/bump.yml). Specify a
518+
version (like "x.y.z", without quotes) and a single line changelog entry. (This entry will have a
519+
dash prepended, so that it would look normal in a list. This is working around [the lack of a
520+
multi-line input in Github
521+
Actions](https://github.community/t/multiline-inputs-for-workflow-dispatch/163906).) This will push
522+
a preparatory commit updating version numbers and the changelog like [this
523+
one](https://github.com/mozilla/rust-android-gradle/commit/2a637d1797a5d0b5063b8d2f0a3d4a4938511154),
524+
and make a **draft** Github Release with a name like `vx.y.z`. After verifying that tests pass,
525+
navigate to [the releases panel](https://github.com/mozilla/rust-android-gradle/releases) and edit
526+
the release, finally pressing "Publish release". The release Github workflow will build and publish
527+
the plugin, although it may take some days for it to be reflected on the Gradle plugin portal.
522528

523529
## By hand
524530

0 commit comments

Comments
 (0)