-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[issue-1351] - Implement automation to build and deploy the project d…
…ocumentatiion to GitHub pages (#1352) * [issue-1351] - Adding a build module and a build/docs module * [issue-1351] - Fixing documentation sources * [issue-1351] - Adding a GitHub action workflow to deploy documentation on GitHub Pages
- Loading branch information
Showing
11 changed files
with
170 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: Build and Deploy to GitHub Pages | ||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| arquillian-cube-ref: | ||
| description: 'The Arquillian Cube branch that will be used to build and deploy the documentation' | ||
| required: false | ||
| default: "2.0.0.Alpha1" | ||
| type: string | ||
|
|
||
| jobs: | ||
| build-and-deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ inputs.arquillian-cube-ref }} | ||
| - name: Set up JDK 11 | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 11 | ||
| cache: maven | ||
| - name: Build with Maven | ||
| run: ./mvnw --batch-mode --no-transfer-progress clean package -pl build/docs | ||
| - name: Deploy to GitHub Pages | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| branch: gh-pages | ||
| folder: build/docs/target/generated-docs/ | ||
| git-config-name: Alien Ike | ||
| git-config-email: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>org.arquillian.cube</groupId> | ||
| <artifactId>arquillian-cube-build</artifactId> | ||
| <version>2.0.0.Alpha1</version> | ||
| </parent> | ||
| <artifactId>arquillian-cube-build-docs</artifactId> | ||
| <packaging>pom</packaging> | ||
| <name>Arquillian Cube: Build documentation</name> | ||
|
|
||
| <properties> | ||
| <project.root.dir>${basedir}/../..</project.root.dir> | ||
| <documentation.sources.directory>${project.build.directory}/compiled-sources-docs</documentation.sources.directory> | ||
| </properties> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-antrun-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <phase>generate-sources</phase> | ||
| <goals> | ||
| <goal>run</goal> | ||
| </goals> | ||
| <configuration> | ||
| <target> | ||
| <mkdir dir="${documentation.sources.directory}"/> | ||
| <copy todir="${documentation.sources.directory}"> | ||
| <fileset dir="${project.build.directory}/../../../docs/" includes="*.adoc"/> | ||
| </copy> | ||
| <copy file="${project.build.directory}/../../../README.adoc" tofile="${documentation.sources.directory}/index.adoc"/> | ||
| </target> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.asciidoctor</groupId> | ||
| <artifactId>asciidoctor-maven-plugin</artifactId> | ||
| <version>2.2.6</version> | ||
| <executions> | ||
| <execution> | ||
| <id>output-html-user-guide</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>process-asciidoc</goal> | ||
| </goals> | ||
| <configuration> | ||
| <backend>html5</backend> | ||
| <attributes> | ||
| <toc>left</toc> | ||
| <linkcss>false</linkcss> | ||
| <attribute-missing>warn</attribute-missing> | ||
| <sectnums>true</sectnums> | ||
| <!-- Attribute used to differentiate between built-tin rendering a GitHub project landing page readme vs building a page for publishing --> | ||
| <!-- Example: --> | ||
| <!-- ifdef::generated-doc[] --> | ||
| <!-- ... --> | ||
| <!-- endif::generated-doc[] --> | ||
| <generated-doc>true</generated-doc> | ||
| <project_version>${project.version}</project_version> | ||
| <project_root_dir>${project.root.dir}</project_root_dir> | ||
| </attributes> | ||
| <sourceDirectory>${documentation.sources.directory}</sourceDirectory> | ||
| <sourceDocumentName>index.adoc</sourceDocumentName> | ||
| <logHandler> | ||
| <failIf> | ||
| <severity>WARN</severity> | ||
| </failIf> | ||
| </logHandler> | ||
| <enableVerbose>true</enableVerbose> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| </project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <groupId>org.arquillian.cube</groupId> | ||
| <artifactId>arquillian-cube-parent</artifactId> | ||
| <version>2.0.0.Alpha1</version> | ||
| </parent> | ||
|
|
||
| <artifactId>arquillian-cube-build</artifactId> | ||
| <name>Arquillian Cube: Build Parent</name> | ||
| <packaging>pom</packaging> | ||
|
|
||
| <modules> | ||
| <module>docs</module> | ||
| </modules> | ||
| </project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters