Skip to content

[JAMES-4175] improves documentation build repeatability#2952

Merged
jeantil merged 3 commits intoapache:masterfrom
jeantil:reproductible-env
Feb 27, 2026
Merged

[JAMES-4175] improves documentation build repeatability#2952
jeantil merged 3 commits intoapache:masterfrom
jeantil:reproductible-env

Conversation

@jeantil
Copy link
Contributor

@jeantil jeantil commented Feb 26, 2026

With this PR :

  • staged version of the documentation is documented making it more discoverable
  • following the homepage build instructions works again both with docker and with the experimental nix env
  • the maven site build is fixed at least with the experimental nix env (and probably using any other mean of installing jdk21 and maven locally) using the official maven docker image instead of a custom built one would probably also work but I didn't try
  • building the antora doc is now documented in the community/website page and I synced the corresponding section with the readme.

Copy link
Contributor

@chibenwa chibenwa left a comment

Choose a reason for hiding this comment

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

Awesome!

pom.xml Outdated
Comment on lines 4021 to 4008
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-doap-plugin</artifactId>
<executions>
<execution>
<id>site</id>
<goals>
<goal>generate</goal>
</goals>
<phase>site</phase>
</execution>
</executions>
</plugin>
<!-- <plugin>-->
<!-- <groupId>org.apache.maven.plugins</groupId>-->
<!-- <artifactId>maven-doap-plugin</artifactId>-->
<!-- <executions>-->
<!-- <execution>-->
<!-- <id>site</id>-->
<!-- <goals>-->
<!-- <goal>generate</goal>-->
<!-- </goals>-->
<!-- <phase>site</phase>-->
<!-- </execution>-->
<!-- </executions>-->
<!-- </plugin>-->
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's remove rather than comment?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thank god for your comment !

I commented it out because the doap plugin is Really Slow ™️
it doesn't break the build but I disabled it to be able to iterate faster on the report generation

I have reactivated it an added comments on the commented out plugins with JIRA numnbers to track their possible reactivation, I think it's worth it letting them commented in the pom

- Adds missing `bundler` command.
- Adds Gemfile.lock so `bundle install` downloads the same artifacts.
- gitignore jekyll output directory
- update website build instructions
The current process removes all modules from the root POM resulting in no reports being generated.

This commit improves the situation by restoring a full maven site generation and disabling only problematic reports :

javadoc triggers unresolved symbols in mpt/mavenplugin

findbugs is not compatible with our current jdk and requires a migration to spotbugs
Ensures README is always aligned with antora build section in community/websitew
@jeantil jeantil merged commit e28b26b into apache:master Feb 27, 2026
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.

3 participants