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

Remove Javadocs from Maven's install phase, make Debian/GitHub Actions specific pomfile. #3521

Merged
merged 2 commits into from
Nov 27, 2019
Merged

Conversation

TheFlagCourier
Copy link
Member

@TheFlagCourier TheFlagCourier commented Nov 27, 2019

See individual commits for changes and summary. Addresses issue #3519. Individual developers are now responsible for building their own Javadocs and making necessary tweaks to the Pom file to automate them.

pom_deb.xml is now used for GitHub Actions' workflow. It can also be used on Debian-based distributions such as Ubuntu, Mint, and ZorinOS. It may or may not be compatible with MacOSX and other BSD/Linux/Unix systems. To do so, Maven will need to be ran with the --file argument. IDE helper scripts may not work, or may need editing.

The pom_deb.xml file will always assume the javadoc executable is in the Java_Home directory, under the bin folder.

This allows github actions to continue to build the Javadocs without normal developers having to edit or remove the path to the Javadoc executable every time.
Javadocs can still be built by running `mvn javadoc:javadoc` or `mvn javadoc:jar`

(Developers are responsible for properly configuring their path to their Javadoc executable. See Previous Commit)
@LlmDl LlmDl merged commit f209d8e into TownyAdvanced:master Nov 27, 2019
LlmDl added a commit that referenced this pull request Nov 27, 2019
javadocs, courtesy of TheFlagCourier with PR #3521.
    - Closes ticket #3519.
@TheFlagCourier TheFlagCourier deleted the javadoc branch November 28, 2019 17:52
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