Skip to content

Commit

Permalink
feature/IVYPORTAL-18151-Create-Github-Action-for-Building-Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ntloc-axonivy
ntloc-axonivy committed Dec 26, 2024
1 parent 6f862a9 commit 556058b
Showing 1 changed file with 70 additions and 117 deletions.
187 changes: 70 additions & 117 deletions .github/workflows/portal-documentation.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,138 +26,91 @@ permissions:
contents: write

jobs:
build-screenshot:
runs-on: ubuntu-latest


build-document:
runs-on: portal-01
steps:
- uses: actions/checkout@v4
with:
ref: master
# - name: test summary
# run: echo "### Documentation Build Warnings" >> $GITHUB_STEP_SUMMARY

- uses: actions/checkout@v4
- name: Set up Java
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '21'

- name: Set up Maven
uses: stCarolas/setup-maven@v5
with:
maven-version: 3.9.8

- name: Extract Engine
run: docker ps

shell: bash

# - name: Build Docker image for building
# run: docker build -t build-portal-modules -f build/Dockerfile .

- name: Build Modules
id: build
- name: Get current version
id: get_version
run: |
addgroup --gid 1001 build && adduser --uid 1001 --gid 1001 --disabled-password --gecos "" build
MODULES=("AxonIvyPortal/portal-components" "AxonIvyPortal/portal" "AxonIvyPortal/PortalKitTestHelper" "Showcase/portal-user-examples" "Showcase/portal-developer-examples" "Showcase/InternalSupport" "Showcase/portal-components-examples")
BUILT_MODULES=()
set +e # Allow the script to continue even if a build fails
for MODULE in "${MODULES[@]}"; do
if mvn clean install -f ${MODULE}/pom.xml; then
BUILT_MODULES+=("$MODULE")
else
echo "WARNING: Build failed for $MODULE" >&2
fi
done
set -e # Re-enable exit on error
# Debug logs
echo "DEBUG: BUILT_MODULES = ${BUILT_MODULES[*]}"
echo "built_modules=${BUILT_MODULES[*]}" | tee -a $GITHUB_OUTPUT
# build-document:
# runs-on: portal-01
# steps:
# # - name: test summary
# # run: echo "### Documentation Build Warnings" >> $GITHUB_STEP_SUMMARY

# - uses: actions/checkout@v4
# - name: Set up Java
# uses: actions/setup-java@v4
# with:
# distribution: 'temurin'
# java-version: '21'

# - name: Set up Maven
# uses: stCarolas/setup-maven@v5
# with:
# maven-version: 3.9.8

# - name: Get current version
# id: get_version
# run: |
# VERSION=$(mvn help:evaluate -Dexpression=revision -q -DforceStdout -f Documentation/pom.xml)
# if [[ "$VERSION" == "null object or invalid expression" ]]; then
# echo "Error: could not evaluate maven revision property"
# # Stops the workflow if the condition is met
# exit 1
# fi
# echo "version=$VERSION" >> "$GITHUB_OUTPUT"
# echo "Version is $VERSION"
VERSION=$(mvn help:evaluate -Dexpression=revision -q -DforceStdout -f Documentation/pom.xml)
if [[ "$VERSION" == "null object or invalid expression" ]]; then
echo "Error: could not evaluate maven revision property"
# Stops the workflow if the condition is met
exit 1
fi
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
echo "Version is $VERSION"
# - name: Unzip portal screenshots
# run: |
# unzip /mnt/portal02/document-screenshots/portal-document-screenshots-selenide-${{ steps.get_version.outputs.version }}.zip \
# -d Documentation/portal-guide/source/screenshots
# - name: Unzip portal screenshots
# run: |
# unzip /mnt/portal02/document-screenshots/portal-document-screenshots-selenide-${{ steps.get_version.outputs.version }}.zip \
# -d Documentation/portal-guide/source/screenshots

# - name: Generate resources
# run: |
# mvn clean process-resources -Divy.engine.version=[13.1.0,] -Divy.engine.download.url=https://developer.axonivy.com/permalink/dev/axonivy-engine.zip -f Documentation/public-api/pom.xml
# mvn clean generate-resources -f Documentation/pom.xml
- name: Generate resources
run: |
mvn clean process-resources -Divy.engine.version=[13.1.0,] -Divy.engine.download.url=https://developer.axonivy.com/permalink/dev/axonivy-engine.zip -f Documentation/public-api/pom.xml
mvn clean generate-resources -f Documentation/pom.xml
# - name: Run substitute
# shell: bash
# run: chmod +x Documentation/portal-guide/substitute.sh && Documentation/portal-guide/substitute.sh ${{ inputs.ivyVersion }}

# # - name: Build Documentation HTML
# # run: |
# # docker run -u root:root --rm -v ${{ github.workspace }}:/workspace -w /workspace/Documentation/portal-guide \
# # axonivy/build-container:read-the-docs-2 make -C /doc-build html BASEDIR='/workspace/Documentation/portal-guide' VERSION=${{ steps.get_version.outputs.version }}

# # - name: Install or deploy document
# # run: |
# # if [[ "${{ steps.get_version.outputs.version }}" == *SNAPSHOT* ]]; then
# # PHASE="install"
# # else
# # PHASE="deploy"
# # fi
# # echo "Running 'clean $PHASE' for version ${{ steps.get_version.outputs.version }}"
# # mvn clean $PHASE -f Documentation/pom.xml

# # - name: Upload artifacts
# # uses: actions/upload-artifact@v4
# # with:
# # name: documentation
# # path: |
# # Documentation/*/build/html/**/*
# # Documentation/*/target/*.zip

# # - name: Cleanup
# # shell: bash
# # run: rm -rf ${{ github.workspace }}/*
- name: Run substitute
shell: bash
run: chmod +x Documentation/portal-guide/substitute.sh && Documentation/portal-guide/substitute.sh ${{ inputs.ivyVersion }}

# test-deploy:
# runs-on: portal-01
# container:
# image: axonivy/build-container:read-the-docs-2
# env:
# NODE_ENV: development
# volumes:
# - ${{ github.workspace }}:/workspace
# options: --rm -w /workspace/Documentation/portal-guide
# steps:
# - name: Check for dockerenv file
# run: (ls /.dockerenv && echo Found dockerenv) || (echo No dockerenv)
- name: Build Documentation HTML
run: |
docker run -u root:root --rm -v ${{ github.workspace }}:/workspace -w /workspace/Documentation/portal-guide \
axonivy/build-container:read-the-docs-2 make -C /doc-build html BASEDIR='/workspace/Documentation/portal-guide' VERSION=${{ steps.get_version.outputs.version }} > sphinx-warnings.log || true
WARNINGS=$(grep -c "WARNING" sphinx-warnings.log || echo 0)
echo "locne"
echo "Found $WARNINGS warnings."
# - name: Install or deploy document
# run: |
# if [[ "${{ steps.get_version.outputs.version }}" == *SNAPSHOT* ]]; then
# PHASE="install"
# else
# PHASE="deploy"
# fi
# echo "Running 'clean $PHASE' for version ${{ steps.get_version.outputs.version }}"
# mvn clean $PHASE -f Documentation/pom.xml

# - name: Upload artifacts
# uses: actions/upload-artifact@v4
# with:
# name: documentation
# path: |
# Documentation/*/build/html/**/*
# Documentation/*/target/*.zip

- name: Cleanup
shell: bash
run: rm -rf ${{ github.workspace }}/*

test-deploy:
runs-on: portal-01
container:
image: axonivy/build-container:read-the-docs-2
env:
NODE_ENV: development
volumes:
- ${{ github.workspace }}:/workspace
options: --rm -w /workspace/Documentation/portal-guide
steps:
- name: Check for dockerenv file
run: (ls /.dockerenv && echo Found dockerenv) || (echo No dockerenv)

0 comments on commit 556058b

Please sign in to comment.