From 6aff8c01df3c90753303109f75b774d369eaa3f7 Mon Sep 17 00:00:00 2001 From: jtama Date: Wed, 4 Dec 2024 12:17:49 +0100 Subject: [PATCH] Amend release process description --- docs/modules/project/pages/hacking.adoc | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/modules/project/pages/hacking.adoc b/docs/modules/project/pages/hacking.adoc index 223b56ba..47e286e5 100644 --- a/docs/modules/project/pages/hacking.adoc +++ b/docs/modules/project/pages/hacking.adoc @@ -368,25 +368,33 @@ In addition, you can submit pull requests to downstream project: [%interactive] * [ ] submit a pull request downstream to update Asciidoctor reveal.js version in the Asciidoctor Docker Container -** modify the `Dockerfile`, `Makefile` and `README.adoc` in: https://github.com/asciidoctor/docker-asciidoctor +** modify the `Dockerfile`, `tests/asciidoctor.bats`, `README.md` and `README.adoc` in: https://github.com/asciidoctor/docker-asciidoctor * [ ] submit a pull request downstream to update AsciidoctorJ reveal.js version -** modify `gradle.properties`, `asciidoctorj-revealjs/gradle.properties` and `asciidoctorj-revealjs/build.gradle` in: https://github.com/asciidoctor/asciidoctorj-reveal.js +** modify `gradle.properties` and `asciidoctorj-revealjs/gradle.properties`. if `reveal.js`version has been updated, + +also ammend `WhenBackendIsRevealJs.java` in both `tests` and `itests` folders and `README.adoc` in: https://github.com/asciidoctor/asciidoctorj-reveal.js === Prepare next version +This step is optional and should only be done if needed. + . Run the following command and follow the instructions: $ npm run release:next === Maintenance branch -You can create a maintenance branch from a tag. +You can (not must) create a maintenance branch from a tag. Please use the following name convention: `\{major}.\{minor}.x` (e.g., `4.1.x`). [%interactive] * [ ] push the maintenance branch: `git push origin 4.1.x` * [ ] don't forget to update Antora playbook to add this branch: https://github.com/asciidoctor/docs.asciidoctor.org/edit/main/antora-playbook.yml +=== New major version + +In case of a new major version, you must follow the steps described for a <<_maintenance_branch,Maintenance branch>>. + + == Ruby and asciidoctor-doctest tests === Running tests