Refactoring documentation (#57) #243
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
| # Copyright 2024 Paion Data | |
| # | |
| # 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: | |
| USER: QubitPi | |
| EMAIL: jack20220723@gmail.com | |
| DOCKERHUB_USERNAME: paiondata | |
| jobs: | |
| yaml-lint: | |
| name: YAML Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actionshub/yamllint@main | |
| markdown-lint: | |
| name: Markdown Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actionshub/markdownlint@main | |
| with: | |
| filesToIgnoreRegex: "docs/node_modules\\/.*" | |
| tests: | |
| name: Unit & Integration Tests | |
| needs: [yaml-lint, markdown-lint] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up JDK | |
| uses: QubitPi/hashicorp-aws/.github/actions/jdk-setup@master | |
| - name: Run unit & integration tests | |
| run: mvn -B clean verify | |
| documentation: | |
| name: Test & Release Documentation (including Javadoc) | |
| needs: tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Test environment setup | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'adopt' | |
| java-version: '17' | |
| - name: Install dependencies | |
| working-directory: docs | |
| run: yarn | |
| - name: Build documentations | |
| working-directory: docs | |
| run: yarn build | |
| - name: Load CNAME file | |
| if: github.ref == 'refs/heads/master' | |
| run: cp CNAME build | |
| working-directory: docs | |
| - name: Generate Javadoc | |
| run: mvn -B clean verify javadoc:aggregate | |
| - name: Move Javadoc into documentation directory | |
| if: github.ref == 'refs/heads/master' | |
| run: mv target/site/apidocs/ docs/build/apidocs/ | |
| - 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 }} | |
| examples-basic-app-docker-image: | |
| name: Test & Release aristotle-example-basic App Docker Image | |
| needs: tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up JDK | |
| uses: QubitPi/hashicorp-aws/.github/actions/jdk-setup@master | |
| - name: Build App WAR file so that Docker can pickup during image build | |
| run: mvn clean package | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v2 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v2 | |
| - name: Test image build | |
| uses: docker/build-push-action@v3 | |
| with: | |
| context: athena-examples/athena-example-books | |
| push: false | |
| - name: Login to DockerHub | |
| if: github.ref == 'refs/heads/master' | |
| uses: docker/login-action@v2 | |
| with: | |
| username: ${{ env.DOCKERHUB_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_TOKEN }} | |
| - name: Push image to DockerHub | |
| if: github.ref == 'refs/heads/master' | |
| uses: docker/build-push-action@v3 | |
| with: | |
| context: athena-examples/athena-example-books | |
| push: true | |
| tags: ${{ env.DOCKERHUB_USERNAME }}/athena-example-books:latest | |
| release: | |
| name: Release | |
| needs: tests | |
| if: github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Release | |
| uses: paion-data/maven-central-release-action@master | |
| with: | |
| user: QubitPi | |
| email: jack20220723@gmail.com | |
| gpg-keyname: ${{ secrets.GPG_KEYNAME }} | |
| gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} | |
| gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }} | |
| server-username: ${{ secrets.MAVEN_CENTRAL_USERNAME }} | |
| server-password: ${{ secrets.MAVEN_CENTRAL_TOKEN }} | |
| version-properties: version.athena |