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

Fix javadoc when enable preview flag is added #2338

Merged
merged 3 commits into from
Jul 29, 2022
Merged

Conversation

iamdanfox
Copy link
Contributor

@iamdanfox iamdanfox commented Jul 29, 2022

Before this PR

We'd successfully add the -enable-preview flag to the javadoc task, but since we don't have the -source or --release flags, it fails with the following:

> Task :witchcraft-example-api:witchcraft-example-api-undertow:javadoc FAILED
error: --enable-preview must be used with either -source or --release
1 error

We did not have an automated test that actually invokes javadoc, hence why this bug slipped in.

After this PR

==COMMIT_MSG==
javadoc tasks are now properly configured when --enable-preview is used
==COMMIT_MSG==

We now have a failing test that runs javadoc, and the last commit fixes it!

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Jul 29, 2022

Generate changelog in changelog/@unreleased

Type
See change types. Select one:

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

javadoc tasks are now properly configured when --enable-preview is used

Check the box to generate changelog(s)

  • Generate changelog entry

@bulldozer-bot bulldozer-bot bot merged commit c6b3790 into develop Jul 29, 2022
@bulldozer-bot bulldozer-bot bot deleted the dfox/fix-javadoc branch July 29, 2022 18:40
@svc-autorelease
Copy link
Collaborator

Released 4.151.0

@iamdanfox
Copy link
Contributor Author

Sorry I didn't include a test for this first time round!!

This was referenced Jul 29, 2022
bulldozer-bot bot pushed a commit to palantir/witchcraft-api that referenced this pull request Jul 30, 2022
###### _excavator_ is a bot for automating changes across repositories.

Changes produced by the roomba/latest-baseline-oss check.

# Release Notes
## 4.151.0
| Type | Description | Link |
| ---- | ----------- | ---- |
| Fix | javadoc tasks are now properly configured when `--enable-preview` is used | palantir/gradle-baseline#2338 |



To enable or disable this check, please contact the maintainers of Excavator.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants