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.

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

Migrate site infrastructure to Antora #155

Merged
merged 7 commits into from
Apr 9, 2024
Merged

Migrate site infrastructure to Antora #155

merged 7 commits into from
Apr 9, 2024

Conversation

vy
Copy link
Member

@vy vy commented Apr 9, 2024

apache/logging-log4j2#2427 migrated Log4j 2 to Antora. apache/logging-log4j2#2443 cloned this work for Log4j 3. This PR clones the very same work to logging-parent to streamline it for all projects extending from it. A short summary of deliverables are shared below.

Deliverables

  • Website is migrated to Antora
  • Auto-generated release notes is re-worked to avoid cluttering the Git history. Now it only runs during the pre-site phase and outputs to target/generated-site instead. That is, compiled src/changelog will not be dumped to src/site anymore.
  • Auto-generated constants.adoc is directed to target/generated-site too (similar to release notes explained above)
  • No web server is needed to view the generated website anymore, one can instead simply open target/site in a browser

Implementation notes

Due to backward incompatible changes, the major version is bumped to 11.

Review kit

  1. Start with pom.xml changes
  2. Review changes to the website, i.e., src/site/antora/modules/ROOT
  3. Review changes to .github

Future work

Once this feature gets released, pom.xml of Log4j 2 and 3 can be trimmed significantly.

@vy vy added this to the 11.0.0 milestone Apr 9, 2024
@vy vy self-assigned this Apr 9, 2024
Copy link
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

LGTM

src/site/antora/.antora.yml Outdated Show resolved Hide resolved
@ppkarwasz
Copy link
Contributor

Since all this PR does is modifying Github Actions can you stage the website after merging this PR to confirm that it works as required?

@vy
Copy link
Member Author

vy commented Apr 9, 2024

Since all this PR does is modifying Github Actions can you stage the website after merging this PR to confirm that it works as required?

I will do that in my follow up PR, where I will implement automatic website publication. 😉

@vy vy merged commit 733486a into main Apr 9, 2024
7 checks passed
@vy vy deleted the antora branch April 9, 2024 19:02
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