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

feat: add Devsite Javadoc profile #121

Merged
merged 5 commits into from Apr 2, 2020
Merged

feat: add Devsite Javadoc profile #121

merged 5 commits into from Apr 2, 2020

Conversation

tbpg
Copy link
Contributor

@tbpg tbpg commented Mar 30, 2020

I'm not sure the best way to test this. I tried activating the profile, but it doesn't work because there are no packages to generate docs for, so the antrun replace and copy steps fail.

I copied this from prototypes for java-vision and java-bigtable, which worked.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 30, 2020
pom.xml Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
Copy link
Contributor Author

@tbpg tbpg left a comment

Choose a reason for hiding this comment

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

Thank you! Please take another look.

pom.xml Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated
<delete file="${project.build.directory}/devsite/reference/hierarchy.html" />
<delete file="${project.build.directory}/devsite/reference/index.html" />
<delete file="${project.build.directory}/devsite/reference/lists.js" />
<delete file="${project.build.directory}/devsite/reference/package-list" />
Copy link
Contributor

Choose a reason for hiding this comment

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

We will want to keep package-list available for cross-linking between javadocs. This is the file that is referenced when the javadoc command is provided -link option [1].

[1] https://docs.oracle.com/javase/9/javadoc/javadoc-command.htm#JSJAV-GUID-3894CFD5-88D5-407F-B603-3DCC826AE6EA

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, and good to know! I removed this line.

Copy link
Contributor Author

@tbpg tbpg left a comment

Choose a reason for hiding this comment

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

Thanks! Please take another look.

I also fixed the _project.yaml path.

pom.xml Outdated
<delete file="${project.build.directory}/devsite/reference/hierarchy.html" />
<delete file="${project.build.directory}/devsite/reference/index.html" />
<delete file="${project.build.directory}/devsite/reference/lists.js" />
<delete file="${project.build.directory}/devsite/reference/package-list" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, and good to know! I removed this line.

Copy link
Collaborator

@chingor13 chingor13 left a comment

Choose a reason for hiding this comment

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

We can merge this and let the nightly snapshot build push it to the snapshots repo. We can test downstream before we release this library and roll it out to all the repos

@tbpg
Copy link
Contributor Author

tbpg commented Apr 2, 2020

Sounds good! We will need some additional configuration changes at a later date. But, this will be a great start.

Will one of you merge? I don't have permission.

@chingor13 chingor13 merged commit 7f452fb into googleapis:master Apr 2, 2020
@tbpg tbpg deleted the devsite branch April 2, 2020 17:43
gcf-merge-on-green bot pushed a commit that referenced this pull request Apr 7, 2020
🤖 I have created a release \*beep\* \*boop\* 
---
## [0.5.0](https://www.github.com/googleapis/java-shared-config/compare/v0.4.0...v0.5.0) (2020-04-07)


### Features

* add ban duplicate classes rule ([#126](https://www.github.com/googleapis/java-shared-config/issues/126)) ([e38a7cc](https://www.github.com/googleapis/java-shared-config/commit/e38a7cc949396f8f5696e62cd060e0c076047b8d))
* add devsite javadoc profile ([#121](https://www.github.com/googleapis/java-shared-config/issues/121)) ([7f452fb](https://www.github.com/googleapis/java-shared-config/commit/7f452fb6c5704f6ce0f731085479a28fb99ebcb9))
* add maven flatten plugin ([#127](https://www.github.com/googleapis/java-shared-config/issues/127)) ([fb00799](https://www.github.com/googleapis/java-shared-config/commit/fb00799c416d324d68da5b660a26f7ef595c26d9))


### Bug Fixes

* declare com.coveo:fmt-maven-plugin version/configuration ([#90](https://www.github.com/googleapis/java-shared-config/issues/90)) ([5cf71a6](https://www.github.com/googleapis/java-shared-config/commit/5cf71a6ed699907082756e70c2fdee6ad3632f38))


### Dependencies

* update dependency com.google.cloud.samples:shared-configuration to v1.0.13 ([#118](https://www.github.com/googleapis/java-shared-config/issues/118)) ([58ae69e](https://www.github.com/googleapis/java-shared-config/commit/58ae69eb5ba037963cdaed0c2b0e30663bc873eb))
* update dependency com.puppycrawl.tools:checkstyle to v8.29 ([f62292d](https://www.github.com/googleapis/java-shared-config/commit/f62292dab75699a75f8a7d499fe2ccfb7ee93783))
* update dependency org.apache.maven.plugins:maven-antrun-plugin to v1.8 ([#124](https://www.github.com/googleapis/java-shared-config/issues/124)) ([a681536](https://www.github.com/googleapis/java-shared-config/commit/a68153643400c3f3b5c5959cda4dc3b552336427))
* update dependency org.apache.maven.plugins:maven-dependency-plugin to v3.1.2 ([#107](https://www.github.com/googleapis/java-shared-config/issues/107)) ([c9b096b](https://www.github.com/googleapis/java-shared-config/commit/c9b096b81b1f4f8dc2d1302f259f0321722e1ca5))
* update dependency org.apache.maven.plugins:maven-site-plugin to v3.9.0 ([#103](https://www.github.com/googleapis/java-shared-config/issues/103)) ([abe7140](https://www.github.com/googleapis/java-shared-config/commit/abe714060e858c70a83888fb34438c45d97b1168))
* update dependency org.codehaus.mojo:build-helper-maven-plugin to v3.1.0 ([#101](https://www.github.com/googleapis/java-shared-config/issues/101)) ([ac69572](https://www.github.com/googleapis/java-shared-config/commit/ac69572be76e4462fdf65fa6e7f0935c3d51d827))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants