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

TASK-4121 Also build JavaDocs, Maven Site, and upload the latter to Google Cloud #23

Merged
merged 7 commits into from
Jun 21, 2024

Conversation

inkarkat
Copy link
Contributor

This aligns the MavenSetup with what we've implemented in ReBuild, adding the JavaDoc build for feature branches (now that JuicyRaspberryPie additions have proper documentation), building the complete site reports, and uploading that to https://javadocs.dev.reload.works/
This allows users of the reusable workflow (like JuicyRaspberryPie, and eventually also plugins extracted from ReBuild) to publish their documentation.


  • The main commit(s) reference the Fibery ticket via a TASK-NNNN prefix in the commit message subject
  • Include a human-readable description of what the pull request is trying to accomplish
  • The CI build passes

  • New automated tests have been added
  • The changes are already covered by automated tests and have been adapted
  • These manual test cases cover this change:
  • Steps for the reviewer(s) on how they can manually QA the changes:
    • MavenSetup site has been built and uploaded as a trial
    • JuicyRaspberryPie successfully consumed the workflow
  • This is a minor internal change; basic CI/CD coverage is enough
  • This is an incomplete feature hidden behind feature flag:
  • This is proof-of-concept / experimental code not for production / marked @Deprecated
  • No (significant) changes to production code

  • Classes and public methods have documentation (that doesn't just repeat the technical subject in English)
  • Logging is implemented to monitor feature usage and troubleshoot problems in production
  • These ReWiki pages are affected by this change and will be adapted:

inkarkat added 2 commits June 20, 2024 10:52
…ing workflows

Calling workflows may need to do additional tasks (like upload documentation) that require the just-released version number.
By exporting this as a workflow output (cp. https://docs.github.com/en/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow), it doesn't need to be re-read, and an empty value signals that the revision was already tagged so no release actually happened.
This creates the project reports and JavaDoc. For MavenSetup itself, this isn't very useful in itself, but projects that reuse the workflow want to publish the site.
@inkarkat inkarkat force-pushed the housekeeping/enh/export-version branch from 1fc4b59 to edd6d14 Compare June 21, 2024 05:43
inkarkat added 4 commits June 21, 2024 07:50
The site information isn't that interesting for MavenSetup itself, but projects that reuse the workflow should publish their site, as it contains the JavaDocs and dependency information.
If we'd delegate that to calling workflows, the site information would need to be cached or up/downloaded as artifacts because workspace files are not persisted across jobs.
A full site build would take too long, but it's useful to quickly verify the JavaDoc generation.
@inkarkat inkarkat force-pushed the housekeeping/enh/export-version branch from edd6d14 to 011be77 Compare June 21, 2024 05:52
As we're still publishing the latest site. It's also good to do this in order to verify the site build.
@inkarkat inkarkat merged commit 14fa378 into main Jun 21, 2024
4 checks passed
@inkarkat inkarkat deleted the housekeeping/enh/export-version branch June 21, 2024 10:27
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.

1 participant