Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Amend release process description #539

Merged
merged 1 commit into from
Dec 5, 2024
+11 −3
Merged

Amend release process description #539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/modules/project/pages/hacking.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
ggrossetie marked this conversation as resolved.
Show resolved Hide resolved
* [ ] 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 amend `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
Expand Down