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.

Sign up for GitHub

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

Jump to bottom

feat: adding pom profile to generate docfx yml from javadoc #213

Merged
merged 3 commits into from Jan 21, 2021
Merged

feat: adding pom profile to generate docfx yml from javadoc #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d382ab3
feat: adding pom profile to generate docfx yml from javadoc
eaball35 Jan 21, 2021
46284b7
fix: update pom path
eaball35 Jan 21, 2021
c575d9c
fix: update path to be less explicit
eaball35 Jan 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .kokoro/release/common.cfg
View file
Open in desktop
Expand Up @@ -47,3 +47,6 @@ before_action {
}
}
}

# Downloads docfx doclet resource. This will be in ${KOKORO_GFILE_DIR}/<doclet name>
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/docfx"
63 changes: 38 additions & 25 deletions pom.xml
View file
Open in desktop
Expand Up @@ -653,48 +653,61 @@
</profile>

<profile>
<!-- NOTE - this profile is still in progress and needs work -->
<id>docFX</id>
<activation>
<property>
<!-- Activate with -P docFX -->
<name>docFX</name>
</property>
</activation>
<build>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<phase>site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
<reportSets>
<reportSet>
<id>docFX</id>
<reports>
<report>javadoc</report>
<report>aggregate</report>
<report>aggregate-jar</report>
</reports>
</reportSet>
</reportSets>
<configuration>
<doclet>com.microsoft.doclet.DocFxDoclet</doclet>
<docletArtifact>
<groupId>com.microsoft</groupId>
<artifactId>docfx-doclet</artifactId>
<version>1.0-SNAPSHOT</version><!-- this is temporary - NO PRODUCTION USE -->
</docletArtifact>
<additionalDependencies>
<additionalDependency>
<groupId>com.google.j2objc</groupId>
<artifactId>j2objc-annotations</artifactId>
<version>1.3</version>
</additionalDependency>
</additionalDependencies>
<useStandardDocletOptions>false</useStandardDocletOptions>
<additionalOptions>-outputpath ${project.build.directory}/docfx/</additionalOptions>
<!-- Add additional options here when needed -->
<docletPath>${env.KOKORO_GFILE_DIR}/docfx-doclet-1.0-SNAPSHOT-jar-with-dependencies-143274.jar</docletPath>
<additionalOptions>-outputpath ${project.build.directory}/docfx-yml</additionalOptions>
<doclint>none</doclint>
<show>protected</show>
<nohelp>true</nohelp>
<groups>
<group>
<title>Test helpers packages</title>
<packages>com.google.cloud.testing</packages>
</group>
<group>
<title>SPI packages</title>
<packages>com.google.cloud.spi*</packages>
</group>
</groups>
<links>
<link>https://googleapis.dev/java/api-common/</link>
<link>https://googleapis.dev/java/gax/</link>
<link>https://googleapis.dev/java/google-auth-library/</link>

<link>https://developers.google.com/protocol-buffers/docs/reference/java/</link>
<link>https://googleapis.github.io/common-protos-java/apidocs/</link>
<link>https://grpc.io/grpc-java/javadoc/</link>
</links>
</configuration>

</plugin>
</plugins>
</build>
</reporting>
</profile>

<profile>
Expand Down