added configuration to deploy documentation to GitHub pages when a release is happening

adapted documentation configuration
This commit is contained in:
Sheldan
2020-06-03 21:52:58 +02:00
parent db8afde7ea
commit 601c4b7121
5 changed files with 43 additions and 12 deletions

View File

@@ -1,4 +1,4 @@
name: Publish package to GitHub Packages
name: Publish package to GitHub Packages and deploy documentation to GitHub pages
on:
release:
types: [created]
@@ -7,11 +7,28 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
persist-credentials: false
- name: Set up Java for publishing to GitHub Packages
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: Load current version
id: version
run: echo "::set-output name=version::$(mvn -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive exec:exec)"
- name: Publish to GitHub Packages
run: mvn -f abstracto-application/pom.xml -B deploy
run: mvn -B deploy -P documentation -Dmaven.wagon.http.pool=false -DskipTests=true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Install SSH Client
uses: webfactory/ssh-agent@v0.3.0
with:
ssh-private-key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
- name: Deploy documentation to GitHub pages
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
REPOSITORY_NAME: Sheldan/abstracto-docs
TARGET_FOLDER: docs/${{ steps.version.outputs.version }}
BRANCH: master
SSH: true
FOLDER: abstracto-application/documentation/target/generated-docs

View File

@@ -44,6 +44,8 @@
<sourceDirectory>src/main/docs/asciidoc</sourceDirectory>
<sourceDocumentName>main.adoc</sourceDocumentName>
<attributes>
<revnumber>${project.version}</revnumber>
<revdate>${maven.build.timestamp}</revdate>
</attributes>
</configuration>
<executions>
@@ -56,6 +58,7 @@
<configuration>
<backend>pdf</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<outputFile>documentation.pdf</outputFile>
<attributes>
<icons>font</icons>
<pagenums/>
@@ -72,6 +75,7 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>index.html</outputFile>
<sourceDirectory>src/main/docs/asciidoc</sourceDirectory>
<backend>html</backend>
<doctype>book</doctype>

View File

@@ -1,13 +1,14 @@
= Abstracto Discord Bot Documentation
Sheldan https://github.com/Sheldan
1.0, May 10, 2020
Sheldan https://github.com/Sheldan/abstracto
:toc:
:toclevels: 5
:sectnums:
:title-page:
:sectnumlevels: 5
:icons: font
== Description
Abstracto is a feature rich Discord bot written in Java and uses JDA as the wrapper for the Discord API.
This documentation is split into two parts: Technical documentation and user documentation.

View File

@@ -27,13 +27,9 @@
<module>coverage</module>
</modules>
<distributionManagement>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/Sheldan/abstracto</url>
</repository>
</distributionManagement>
<properties>
<maven.build.timestamp.format>yyyy/MM/dd HH:mm</maven.build.timestamp.format>
</properties>
<build>

13
pom.xml
View File

@@ -28,6 +28,19 @@
<maven.compiler.source>1.8</maven.compiler.source>
</properties>
<distributionManagement>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/Sheldan/abstracto</url>
</repository>
</distributionManagement>
<scm>
<url>https://maven.pkg.github.com/Sheldan/abstracto</url>
</scm>
<modules>
<module>abstracto-application</module>
<module>database</module>