Skip to content

Add documentations

Add documentations #5

Workflow file for this run

# Copyright Jiaqi Liu
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
name: CI/CD
"on":
pull_request:
push:
branches:
- master
env:
JDK_VERSION: 17
JDK_DISTRIBUTION: 'adopt'
USER: QubitPi
EMAIL: [email protected]
jobs:
tests:
name: Unit & Integration Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Test environment setup
uses: ./.github/actions/ci-setup
- name: Set up Docker for Integration Tests
uses: docker-practice/actions-setup-docker@master
- name: Run unit & integration tests
run: mvn -B clean verify
deploy-docs:
needs: tests
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: Set up JDK
uses: paion-data/immutable-infrastructure-as-a-service/.github/actions/jdk-setup@master
- name: Install Dependencies
working-directory: docs
run: yarn
- name: Build Documentation
working-directory: docs
run: yarn build
- name: Generate Javadoc
run: mvn -B clean javadoc:javadoc
- name: Move Javadoc into documentation directory
if: github.ref == 'refs/heads/master'
run: mv target/site/apidocs/ docs/build/apidocs/
- name: Load CNAME file
if: github.ref == 'refs/heads/master'
run: cp docs/CNAME docs/build
- name: Deploy Documentation (including Javadoc) to GitHub Pages
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build
enable_jekyll: false
user_name: ${{ env.USER }}
user_email: ${{ env.EMAIL }}