Skip to content
Open
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
88 changes: 13 additions & 75 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,109 +23,47 @@ permissions:
jobs:

doc-style:
name: "Check documentation style"
name: Check documentation style
runs-on: ubuntu-latest
steps:
- name: "Check documentation style"
uses: ansys/actions/doc-style@v10
- name: Check documentation style
uses: ansys/actions/doc-style@1096998b81f7ebdea116b683e11f3a8bda759ca6 # v10.0.14
with:
token: ${{ secrets.GITHUB_TOKEN }}

doc-build:
name: "Build project documentation"
name: Build project documentation
runs-on: ubuntu-22.04
steps:
- name: Setup headless display
uses: pyvista/setup-headless-display-action@v4
uses: pyvista/setup-headless-display-action@7d84ae825e6d9297a8e99bdbbae20d1b919a0b19 # v4.2

- name: "Install mermaid-cli"
- name: Install mermaid-cli
run: npm install -g @mermaid-js/mermaid-cli

- name: "Install GraphViz"
- name: Install GraphViz
shell: bash
run: |
sudo apt-get update
sudo apt-get install graphviz

- name: "Build project documentation"
uses: ansys/actions/doc-build@v10
- name: Build project documentation
uses: ansys/actions/doc-build@1096998b81f7ebdea116b683e11f3a8bda759ca6 # v10.0.14
with:
python-version: ${{ env.MAIN_PYTHON_VERSION }}
use-python-cache: false
skip-install: true
dependencies: 'texlive-latex-extra latexmk nodejs npm'

doc-deploy:
name: "Deploy documentation"
name: Deploy documentation
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
if: github.event_name == 'push' && !contains(github.ref, 'refs/tags')
needs: doc-build
steps:

- name: "Download HTML documentation artifacts"
uses: actions/download-artifact@v5
with:
name: documentation-html
path: documentation-html

- uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: documentation-html
cname: ${{ env.DOCUMENTATION_CNAME }}
full_commit_message: ${{ github.event.head_commit.message }}
force_orphan: true

release-github:
name: "Release to GitHub"
runs-on: ubuntu-latest
if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
needs: doc-build
steps:

- name: "Download HTML documentation"
uses: actions/download-artifact@v5
with:
name: documentation-html
path: documentation-html

- name: "Zip HTML documentation"
uses: vimtor/action-zip@v1
with:
files: documentation-html
dest: documentation-html.zip

- name: "Download PDF documentation"
uses: actions/download-artifact@v5
with:
name: documentation-pdf
path: documentation-pdf

- name: "Zip PDF documentation"
uses: vimtor/action-zip@v1
with:
files: documentation-pdf
dest: documentation-pdf

- name: "Display the structure of downloaded files"
shell: bash
run: ls -R

- name: "Release to GitHub"
uses: softprops/action-gh-release@v2
with:
files: |
documentation-html.zip
documentation-pdf

doc-deploy-github-release:
name: "Deploy documentation (stable)"
runs-on: ubuntu-latest
needs: [release-github]
steps:

- name: "Download HTML documentation artifacts"
uses: actions/download-artifact@v5
- name: Download HTML documentation artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: documentation-html
path: documentation-html
Expand Down