Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 24 additions & 50 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -1,73 +1,47 @@
name: Generate API reference via Doxygen and push to GitHub Pages
env:
# Specify the doc version to which the API reference belongs
doc_version: 3.6.0

on:
push:
branches:
# Remember to update the branch name when you create a new branch
- master
workflow_dispatch:
inputs:
branch_name:
description: 'Which git branch should I check out?'
required: true

python_version:
description: 'Python SDK version to use for documentation'
required: true


jobs:
build:
runs-on: ubuntu-latest
env:
BRANCH_NAME: ${{ github.event.inputs.branch_name }}
PYTHON_VERSION: ${{ github.event.inputs.python_version }}

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.branch_name }}
fetch-depth: 0 # fetch all commits/branches for gitversion

- name: Extract branch name
run: echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/})" >> $GITHUB_ENV

- name: Install Doxygen
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz

# Generate HTML files
- name: Generate Documentation
# Generate Python API reference
- name: Generate Documentation for Python
run: |
echo "OUTPUT_DIRECTORY=$BRANCH_NAME" >> doxygen-config
doxygen doxygen-config

echo "PROJECT_NUMBER=${PYTHON_VERSION}" >> doxygen/python-config
mkdir -p "${PYTHON_VERSION}"
echo "OUTPUT_DIRECTORY=${PYTHON_VERSION}" >> doxygen/python-config
doxygen doxygen/python-config

# Deploy the generated HTML files to the gh-pages branch
- name: Deploy to gh-pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ${{ env.BRANCH_NAME }}/html
target-folder: ${{ env.BRANCH_NAME }}

# - name: show gh-pages branch
# run: |
# git branch
# git checkout .
# git checkout gh-pages

# # Compresses HTML files into a tar.gz file
# - name: compress api reference
# run: |
# tar -zcvf $BRANCH_NAME.tar.gz $BRANCH_NAME

# - name: transfer api reference
# uses: appleboy/scp-action@master
# with:
# host: 20.163.77.63
# username: azureuser
# password: ${{ secrets.ENSITE_PASSWORD }}
# port: 404
# source: $BRANCH_NAME.tar.gz
# # Return error if the target doc version does not already exist
# target: /var/www/ent-docs/${{ env.doc_version }}/

# - name: uncompress ap reference
# uses: appleboy/ssh-action@master
# with:
# host: 20.163.77.63
# username: azureuser
# password: ${{ secrets.ENSITE_PASSWORD }}
# port: 404
# script: |
# mkdir -p /var/www/ent-docs/${{ env.doc_version}}/api/python/
# tar -zxf /var/www/ent-docs/${{ env.doc_version}}/$BRANCH_NAME.tar.gz -C /var/www/ent-docs/${{ env.doc_version}}/api/python/
folder: ${PYTHON_VERSION}/html
target-folder: ${PYTHON_VERSION}