Skip to content

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

Open
ttelang wants to merge 6 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 6 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
sdk list java

# Install JDK 17 (Microsoft build)
sdk install java 17.0.15-ms

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the line 61, it was stated JDK 21 but here it said JDK 17.

Comment thread DEVELOPERS.adoc

For example, for the catalog service in Chapter 3:
```
http://localhost:5050/catalog/api/products

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you uses Liberty, you should update the port to 9080

Comment thread DEVELOPERS.adoc
**Solution**:
```bash
# Find process using the port (e.g., 5050)
lsof -i :5050

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend to use 9080 across the board

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