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: Set encoding to UTF-8 for Javadoc generation #1121

Merged
merged 1 commit into from
Apr 20, 2022

Conversation

barbeau
Copy link
Member

@barbeau barbeau commented Apr 19, 2022

Summary:

As mentioned in #1101 (comment), we need to configure character encoding for the Javadoc generation plugin separately.

This PR sets the character encoding for the Javadoc plugin.

This PR should also unblock PR #1093.

Closes #1101

Expected behavior:

./gradlew aggregateJavadocs successfully runs on Windows.

I've tested on Windows 10 Home using JDK 11.0.12

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

@github-actions
Copy link
Contributor

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit a057a05 here (report will disappear after 90 days).

Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

Thanks @barbeau !

@maximearmstrong maximearmstrong merged commit aac8ffb into master Apr 20, 2022
@maximearmstrong maximearmstrong deleted the sean/fix-javadocs-windows branch April 20, 2022 12:19
barbeau added a commit that referenced this pull request Apr 20, 2022
maximearmstrong pushed a commit that referenced this pull request Apr 20, 2022
…ow (#1093)

* try multiple versions of java in CI

* additional information regarding the version used

* same thing with pack and doc jobs

* additional OS

* additional OS only on test job

* remove duplicate job prep

* run on multiple OS on pack and doc jobs

* additional OS on package job

* persist artifacts for all OS used

* compileTestJava

* use code instead of emoji

* do not use compileTestJava

* Revert "use code instead of emoji"

This reverts commit 9a068e8.

* do not run doc job on window-latest for now

* fix syntax

* rename task and specify prepare-version-name in needs

* add instructions for encoding while generating the javadocs

* run doc job on windows-latest

* chore: Remove extra Javadoc config

This was fixed in #1121

Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
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.

Failure in generating javadocs on window-latest
3 participants