Skip to content

ci: pin actions version and cleanup workflow #1323

ci: pin actions version and cleanup workflow

ci: pin actions version and cleanup workflow #1323

Workflow file for this run

name: CI
on:
pull_request:
push:
tags:
- "*"
branches:
- main
env:
MAIN_PYTHON_VERSION: '3.13'
DOCUMENTATION_CNAME: 'dev.docs.pyansys.com'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: write
pull-requests: write
jobs:
doc-style:
name: Check documentation style
runs-on: ubuntu-latest
steps:
- name: Check documentation style
uses: ansys/actions/doc-style@1096998b81f7ebdea116b683e11f3a8bda759ca6 # v10.0.14
with:
token: ${{ secrets.GITHUB_TOKEN }}
doc-build:
name: Build project documentation
runs-on: ubuntu-22.04
steps:
- name: Setup headless display
uses: pyvista/setup-headless-display-action@7d84ae825e6d9297a8e99bdbbae20d1b919a0b19 # v4.2
- name: Install mermaid-cli
run: npm install -g @mermaid-js/mermaid-cli
- name: Install GraphViz
shell: bash
run: |
sudo apt-get update
sudo apt-get install graphviz
- 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
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: doc-build
steps:
- name: "Download HTML documentation artifacts"
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: documentation-html
path: documentation-html
- uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
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@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: documentation-html
path: documentation-html
- name: "Zip HTML documentation"
uses: vimtor/action-zip@1379ea20d4c5705669ba81fd626dd01b1c738f26 # v1.2
with:
files: documentation-html
dest: documentation-html.zip
- name: "Download PDF documentation"
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: documentation-pdf
path: documentation-pdf
- name: "Zip PDF documentation"
uses: vimtor/action-zip@1379ea20d4c5705669ba81fd626dd01b1c738f26 # v1.2
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@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
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@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: documentation-html
path: documentation-html
- uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
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