RFR: 8340829: Generated API docs should clearly identify EA builds [v2]

Ambarish Rapte arapte at openjdk.org
Tue Oct 1 23:26:38 UTC 2024


On Fri, 27 Sep 2024 13:07:15 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

>> This PR modifies the header and footer of the javadoc-generated API docs to add "DRAFT $VER-ea+$BLD" to clearly identify an ea build of the docs, and also to make it clear which build number the docs refer to. This matches was the JDK does. For GA builds, there will be no change to what we generate today. Since I had to add logic to filter the javadoc properties defined in `build.javadoc` to add the DRAFT message if not a GA build, I also changed the properties to not hard-code the major version of JavaFX, thus reducing the duplication.
>> 
>> I ran three builds to test this, an ordinary developer build, an EA build, and a GA build as follows:
>> 
>> #### Developer build
>> 
>> Command line:
>> 
>> gradle javadoc
>> 
>> 
>> Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-internal/
>> 
>> #### EA build
>> 
>> Command line:
>> 
>> gradle -PPROMOTED_BUILD_NUMBER=98 -PHUDSON_BUILD_NUMBER=1234 -PHUDSON_JOB_NAME=jfx-dev javadoc
>> 
>> 
>> Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-ea/
>> 
>> #### GA build
>> 
>> Command line:
>> 
>> gradle -PMILESTONE_FCS=true -PPROMOTED_BUILD_NUMBER=99 -PHUDSON_BUILD_NUMBER=4321 -PHUDSON_JOB_NAME=jfx-dev javadoc
>> 
>> 
>> Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-fcs/
>
> Kevin Rushforth has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Address feedback

Marked as reviewed by arapte (Reviewer).

-------------

PR Review: https://git.openjdk.org/jfx/pull/1583#pullrequestreview-2341618041


More information about the openjfx-dev mailing list