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

Fix up site generation, include coverage reports #97

Merged
merged 1 commit into from
Nov 7, 2023
Merged

Fix up site generation, include coverage reports #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/perform-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ jobs:
run: >-
sed
-i
-e 's;<url>.*</url>;<url>${{ github.server_url }}/${{ github.repository }}/tree/${{ github.ref_name }}</url>;'
-e 's;<connection>.*</connection>;<connection>scm:git:${{ github.server_url }}/${{ github.repository }}.git</connection>;'
-e 's;<developerConnection>.*</developerConnection>;<developerConnection>scm:git:${{ github.server_url }}/${{ github.repository }}.git</developerConnection>;'
-e '/<scm>/,/<\/scm>/ s;<url>.*</url>;<url>https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/</url>;'
-e '/<scm>/,/<\/scm>/ s;<connection>.*</connection>;<connection>scm:git:${{ github.server_url }}/${{ github.repository }}.git</connection>;'
-e '/<scm>/,/<\/scm>/ s;<developerConnection>.*</developerConnection>;<developerConnection>scm:git:${{ github.server_url }}/${{ github.repository }}.git</developerConnection>;'
pom.xml

- name: Prepare Maven Release (build code and create tag)
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/render-and-deploy-site.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,16 @@ jobs:
if: ${{ success() && !inputs.dry-run }}

- name: Run Maven Site
# compile needs to run so Maven figures out cross-module dependencies
# and stagingDirectory will have a value appended relative to parent for each module
run: >-
./mvnw
--settings ${{ github.workspace }}/settings.xml
--batch-mode
compile
verify
post-site
site:stage
-Ppitest-include-it
-Ddefault.dokka-srclink-base=${{ github.server_url }}/${{ github.repository }}/tree/${{ inputs.git-ref }}
-DtopSiteURL=https://fwmotion.github.io/${{ github.repository }}
-DtopSiteURL=https://${{ github.repository_owner }}.github.io/${{ github.repository }}

- name: Upload Site Artifacts
uses: actions/upload-pages-artifact@v2
Expand Down
4 changes: 2 additions & 2 deletions cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<packaging>jar</packaging>

<name>3scale CMS Tools (command-line interface)</name>
<url>https://fwmotion.github.io/3scale-cms/cli</url>
<url>https://FwMotion.github.io/3scale-cms/cli</url>
<description><![CDATA[
A Quarkus-based command-line interface to the 3scale Content Management
System. It is recommended to use this via the assembled container image
Expand All @@ -24,7 +24,7 @@
<distributionManagement>
<site>
<id>fwmotion.github.io</id>
<url>https://fwmotion.github.io/3scale-cms/cli</url>
<url>https://FwMotion.github.io/3scale-cms/cli/</url>
</site>
</distributionManagement>

Expand Down
15 changes: 0 additions & 15 deletions cli/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,8 @@
</skin>

<body>
<links>
<item name="GitHub Project" href="https://github.com/FwMotion/3scale-cms" />
</links>

<breadcrumbs>
<item href="${topSiteURL}/aggregate/index.html" name="3scale CMS Tools"/>
<item href="${topSiteURL}/cli/index.html" name="Command-Line Interface"/>
</breadcrumbs>

<menu ref="parent"/>
<menu ref="modules"/>
<menu ref="reports"/>
<menu name="GitHub Project Pages">
<item name="Home" href="https://github.com/FwMotion/3scale-cms"/>
<item name="Issues" href="https://github.com/FwMotion/3scale-cms/issues"/>
<item name="Packages" href="https://github.com/orgs/FwMotion/packages?repo_name=3scale-cms"/>
</menu>

</body>
</site>
29 changes: 27 additions & 2 deletions openapi-generator-template/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<packaging>jar</packaging>

<name>3scale CMS Tools (OpenAPI-Generator Template Customizations)</name>
<url>https://fwmotion.github.io/3scale-cms/openapi-generator-template</url>
<url>https://FwMotion.github.io/3scale-cms/openapi-generator-template</url>
<description><![CDATA[
Customizations to the OpenAPI-Generator templates for use with generating
code in the 3scale-cms project
Expand All @@ -23,12 +23,37 @@
<distributionManagement>
<site>
<id>fwmotion.github.io</id>
<url>https://fwmotion.github.io/3scale-cms/cli</url>
<url>https://FwMotion.github.io/3scale-cms/openapi-generator-template</url>
</site>
</distributionManagement>

<properties>
<project.build.outputTimestamp>1</project.build.outputTimestamp>
</properties>

<reporting>
<excludeDefaults>true</excludeDefaults>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<reportSets>
<reportSet>
<reports>
<report>dependencies</report>
<report>dependency-info</report>
<report>index</report>
<report>issue-management</report>
<report>licenses</report>
<report>plugins</report>
<report>scm</report>
<report>summary</report>
<report>team</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>

</project>
15 changes: 0 additions & 15 deletions openapi-generator-template/src/main/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,8 @@
</skin>

<body>
<links>
<item name="GitHub Project" href="https://github.com/FwMotion/3scale-cms" />
</links>

<breadcrumbs>
<item href="${topSiteURL}/aggregate/index.html" name="3scale CMS Tools"/>
<item href="${topSiteURL}/openapi-generator-template/index.html" name="OpenAPI-Generator Template Customizations"/>
</breadcrumbs>

<menu ref="parent"/>
<menu ref="modules"/>
<menu ref="reports"/>
<menu name="GitHub Project Pages">
<item name="Home" href="https://github.com/FwMotion/3scale-cms"/>
<item name="Issues" href="https://github.com/FwMotion/3scale-cms/issues"/>
<item name="Packages" href="https://github.com/orgs/FwMotion/packages?repo_name=3scale-cms"/>
</menu>

</body>
</site>
9 changes: 5 additions & 4 deletions parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<version>2.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<name>3scale CMS Tools (parent)</name>
<url>https://fwmotion.github.io/3scale-cms</url>
<name>3scale CMS Tools (Parent)</name>
<url>https://FwMotion.github.io/3scale-cms/</url>
<description><![CDATA[
Maven project to provide common base configuration for inheritance by other
related projects
Expand All @@ -17,7 +17,7 @@
<distributionManagement>
<site>
<id>fwmotion.github.io</id>
<url>https://fwmotion.github.io/3scale-cms</url>
<url>https://FwMotion.github.io/3scale-cms/</url>
</site>
</distributionManagement>

Expand Down Expand Up @@ -58,7 +58,7 @@

<maven.top-level-basedir>${project.basedir}/..</maven.top-level-basedir>

<topSiteURL>https://fwmotion.github.io/3scale-cms</topSiteURL>
<topSiteURL>https://FwMotion.github.io/3scale-cms</topSiteURL>

<quarkus.container-image.labels.version>
${project.version}
Expand All @@ -72,6 +72,7 @@
<maven.compiler.release>21</maven.compiler.release>

<!-- Maven site skin version (can't include dots in name) -->
<!-- https://maven.apache.org/skins/maven-fluido-skin/ -->
<maven-fluido-skin-version>2.0.0-M8</maven-fluido-skin-version>

<!-- Requirements -->
Expand Down
7 changes: 4 additions & 3 deletions parent/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@
</links>

<breadcrumbs>
<item href="${topSiteURL}/aggregate/index.html" name="3scale CMS Tools"/>
<item href="${topSiteURL}/parent/index.html" name="Parent"/>
<!-- TODO: Make these use property topSiteURL without erroring out the build -->
<item href="https://FwMotion.github.io/3scale-cms/aggregate/index.html" name="3scale CMS Tools"/>
</breadcrumbs>

<menu ref="modules"/>
<menu ref="reports"/>
<menu name="GitHub Project Pages">

<menu name="GitHub Project Pages" inherit="bottom">
<item name="Home" href="https://github.com/FwMotion/3scale-cms"/>
<item name="Issues" href="https://github.com/FwMotion/3scale-cms/issues"/>
<item name="Packages" href="https://github.com/orgs/FwMotion/packages?repo_name=3scale-cms"/>
Expand Down
6 changes: 3 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<packaging>pom</packaging>

<name>3scale CMS Tools</name>
<url>https://github.com/FwMotion/3scale-cms/tree/main</url>
<url>https://FwMotion.github.io/3scale-cms/aggregate/</url>
<description><![CDATA[
Maven project to group multiple submodules related to 3scale's Content
Management System API, and to handle build ordering and aggregate test
Expand All @@ -28,7 +28,7 @@
</properties>

<scm>
<url>https://github.com/FwMotion/3scale-cms/tree/main</url>
<url>blah</url>
<connection>scm:git:https://github.com/FwMotion/3scale-cms.git</connection>
<developerConnection>scm:git:https://github.com/FwMotion/3scale-cms.git</developerConnection>
<tag>HEAD</tag>
Expand All @@ -37,7 +37,7 @@
<distributionManagement>
<site>
<id>fwmotion.github.io</id>
<url>https://github.com/FwMotion/3scale-cms/tree/main</url>
<url>https://FwMotion.github.io/3scale-cms/aggregate/</url>
</site>
</distributionManagement>

Expand Down
64 changes: 48 additions & 16 deletions rest-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<packaging>jar</packaging>

<name>3scale CMS Tools (REST client library)</name>
<url>https://fwmotion.github.io/3scale-cms/rest-client</url>
<url>https://FwMotion.github.io/3scale-cms/rest-client/</url>
<description><![CDATA[
Java library to interact with 3scale Content Management System via the
CMS's REST API. This requires use of either a Provider Key or an
Expand All @@ -25,7 +25,7 @@
<distributionManagement>
<site>
<id>fwmotion.github.io</id>
<url>https://fwmotion.github.io/3scale-cms/rest-client</url>
<url>https://FwMotion.github.io/3scale-cms/rest-client/</url>
</site>
</distributionManagement>

Expand Down Expand Up @@ -152,6 +152,30 @@
</dependencies>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${version.jacoco-maven-plugin}</version>
<configuration>
<includes>
<!-- Agent uses package/class names -->
<include>com.fwmotion.threescale.cms</include>
<include>com.fwmotion.threescale.cms.*</include>

<!-- Report uses filenames -->
<include>com/fwmotion/threescale/cms/**/*</include>
</includes>
<excludes>
<!-- Exclude Mapstruct-generated classes -->
<exclude>com/fwmotion/threescale/cms/mappers/*Impl.class</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</pluginManagement>

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand All @@ -164,20 +188,6 @@
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<configuration>
<includes>
<!-- Agent uses package/class names -->
<include>com.fwmotion.threescale.cms</include>
<include>com.fwmotion.threescale.cms.*</include>

<!-- Report uses filenames -->
<include>com/fwmotion/threescale/cms/**/*</include>
</includes>
<excludes>
<!-- Exclude Mapstruct-generated classes -->
<exclude>com/fwmotion/threescale/cms/mappers/*Impl.class</exclude>
</excludes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down Expand Up @@ -383,6 +393,28 @@
</reportSet>
</reportSets>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<reportSets>
<reportSet>
<reports>
<report>report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<plugin>
<groupId>org.pitest</groupId>
<artifactId>pitest-maven</artifactId>
<reportSets>
<reportSet>
<reports>
<report>report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>

Expand Down
15 changes: 0 additions & 15 deletions rest-client/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,8 @@
</skin>

<body>
<links>
<item name="GitHub Project" href="https://github.com/FwMotion/3scale-cms" />
</links>

<breadcrumbs>
<item href="${topSiteURL}/aggregate/index.html" name="3scale CMS Tools"/>
<item href="${topSiteURL}/rest-client/index.html" name="REST Client"/>
</breadcrumbs>

<menu ref="parent"/>
<menu ref="modules"/>
<menu ref="reports"/>
<menu name="GitHub Project Pages">
<item name="Home" href="https://github.com/FwMotion/3scale-cms"/>
<item name="Issues" href="https://github.com/FwMotion/3scale-cms/issues"/>
<item name="Packages" href="https://github.com/orgs/FwMotion/packages?repo_name=3scale-cms"/>
</menu>

</body>
</site>
14 changes: 1 addition & 13 deletions src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,10 @@
</skin>

<body>
<links>
<item name="GitHub Project" href="https://github.com/FwMotion/3scale-cms" />
</links>

<breadcrumbs>
<item href="${topSiteURL}/aggregate/index.html" name="3scale CMS Tools"/>
</breadcrumbs>
<breadcrumbs/>

<menu ref="parent"/>
<menu ref="modules"/>
<menu ref="reports"/>
<menu name="GitHub Project Pages">
<item name="Home" href="https://github.com/FwMotion/3scale-cms"/>
<item name="Issues" href="https://github.com/FwMotion/3scale-cms/issues"/>
<item name="Packages" href="https://github.com/orgs/FwMotion/packages?repo_name=3scale-cms"/>
</menu>

</body>
</site>