Skip to content

[Github Actions] Updating workflow for multi-version support in MicroProfile API Tutorial #76

Open
ttelang wants to merge 25 commits into
microprofile:mainfrom
ttelang:patch-2
Open

[Github Actions] Updating workflow for multi-version support in MicroProfile API Tutorial #76
ttelang wants to merge 25 commits into
microprofile:mainfrom
ttelang:patch-2

Conversation

@ttelang

@ttelang ttelang commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

The scope of this PR is updates for infrastructure and project documentations (No Tutorial chapter content is modified in this PR). It contains the following changes:

Updates to CI/CD Workflow (Github Actions)

  • build-and-deploy-tutorial.yml - Updates the GitHub Actions build/deploy pipeline

Updates to Antora configuration: to support multi-version publishing of the MicroProfile API Tutorial. It enables hosting content for multiple MicroProfile releases side-by-side (e.g., MicroProfile 6.1 and 7.1)

  • anotora-assembler.yml - Updates the assembler playbook to source content from multiple version branches and produce a unified output site.
  • antora.yml - Updates the component descriptor (name/version/title/nav metadata) so this branch is recognized as a specific MicroProfile version of the tutorial component.

Documentation Changes

  • Restructures the top-level README.adoc, spliting it into DEVELOPERS.adoc and CONTRIBUTORS.adoc files.
  • Added DEVELOPERS.adoc with guidance for learners looking use the Tutorial content and running the source code examples.
  • Added CONTRIBUTORS.adoc with guidance for contributors regarding how to setup the Antora environment for updating the Tutorial content.

@ttelang ttelang marked this pull request as ready for review April 24, 2026 19:45
@ttelang ttelang changed the title Updating Github Actions Workflow for Multi-version support in MicroProfile API Tutorial [Github Actions] Updating workflow for multi-version support in MicroProfile API Tutorial Apr 25, 2026
@ttelang

ttelang commented May 19, 2026

Copy link
Copy Markdown
Contributor Author

@Emily-Jiang - please review this PR. If everything looks good, please approve and merge. Happy to address any feedback.

Comment thread DEVELOPERS.adoc Outdated
Comment thread DEVELOPERS.adoc Outdated
Comment thread DEVELOPERS.adoc Outdated
ttelang added 2 commits June 15, 2026 15:09
Updated text for clarity and consistency regarding Java versions and tutorial descriptions.
@ttelang

ttelang commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

@Emily-Jiang - please review this PR. If everything looks good, please approve and merge. Happy to address any feedback.

@Emily-Jiang, have resolved all your feedback provided. Please approve and merge.

Comment thread antora-assembler.yml Outdated
Comment thread CONTRIBUTORS.adoc
ttelang added 3 commits June 15, 2026 19:31
The duplicate image (figure1-2.png) exists in both 6.1 and main branches,
causing Antora 3.1.10 to fail during content classification.

Removed 6.1 branch from the assembly for now to get the build working.
To properly support multi-version (6.1 and main), the duplicate images
need to be resolved in both branches upstream.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants