CI: improve workflow (#186)

* CI: improve

* CI: improve

* CI: improve

* CI: improve

* Update .github/workflows/ci_cd.yml

---------

Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: wenhuiuy <[email protected]>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -1,4 +1,4 @@
-name: GitHub CI
+name: CI
 on:
   pull_request:
   workflow_dispatch:
@@ -20,44 +20,55 @@ concurrency:
 
 jobs:
 
-  docs-style:
-    name: Documentation Style Check
+  code-style:
+    name: "Code style"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/code-style@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  doc-style:
+    name: "Documentation style"
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
         uses: ansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-  docs:
-    name: Documentation
+  doc:
+    name: "Documentation build"
     runs-on: ubuntu-latest
-    needs: [docs-style]
+    needs: [doc-style]
     steps:
-      - uses: actions/checkout@v3
+      - name: "Checkout project"
+        uses: actions/checkout@v3
 
-      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+      - name: "Set up Python ${{ env.MAIN_PYTHON_VERSION }}"
         uses: actions/setup-python@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
 
-      - name: Install packages for documentation build
+      - name: "Install system dependencies"
         run: |
           sudo apt-get update
           sudo apt-get install xvfb pandoc texlive-latex-extra latexmk
-          pip install --upgrade build
-          pip install .[doc]
 
-      - name: Login to GitHub Container Registry
+      - name: "Install python dependencies"
+        run: |
+          python -m pip install .[doc]
+
+      - name: "Login to GitHub container registry"
         uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: DPF server activation
+      - name: "Install and run DPF server"
         run: |
           docker pull ghcr.io/ansys/dpf-core:22.2dev
           docker run -d --name dpfserver -p 50054:50052 ghcr.io/ansys/dpf-core:22.2dev && echo "DPF Server active on port 50054."
@@ -67,22 +78,22 @@ jobs:
           docker pull ghcr.io/ansys/ls-pre:latest
           docker run -d --name kw_server -p 50051:50051 ghcr.io/ansys/ls-pre:latest && echo "Keyword server active on port 50051."
 
-      - name: Build the documentation (HTML)
+      - name: "Build the html documentation"
         run: |
           xvfb-run make -C doc html
 
-      - name: Build the documentation (PDF)
+      - name: "Build the pdf documentation"
         run: |
           make -C doc pdf
 
-      - name: Upload HTML documentation
+      - name: "Upload html documentation"
         uses: actions/upload-artifact@v3
         with:
           name: documentation-html
           path: doc/_build/html
           retention-days: 7
 
-      - name: Upload PDF documentation
+      - name: "Upload pdf documentation"
         uses: actions/upload-artifact@v3
         with:
           name: documentation-pdf
@@ -94,7 +105,7 @@ jobs:
         run: |
           docker logs kw_server > server_output.txt
 
-      - name: Upload the server logs
+      - name: "Upload the server logs"
         if: always()
         uses: actions/upload-artifact@v3
         with:
@@ -107,137 +118,123 @@ jobs:
           docker logs dpfserver
           docker stop dpfserver
 
-  style:
-    name: Code style
-    runs-on: ubuntu-latest
-    steps:
-      - name: PyAnsys code style checks
-        uses: ansys/actions/code-style@v4
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
-
   smoke-tests:
-    name: Build and Smoke tests
+    name: "Build wheelhouse for ${{ matrix.os }} and Python ${{ matrix.python-version }}"
     runs-on: ${{ matrix.os }}
-    needs: [style]
+    needs: [code-style]
     strategy:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10'] #, '3.11'] # --> At some point we should include Py3.11
-
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
-      - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v4
+      - uses: ansys/actions/build-wheelhouse@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
   tests:
-    name: Testing
+    name: "Testing"
     runs-on: ubuntu-latest
     needs: [smoke-tests]
     steps:
-      - name: Checkout repository
+      - name: "Checkout repository"
         uses: actions/checkout@v3
 
-      - name: Set up Python
+      - name: "Set up Python"
         uses: actions/setup-python@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
 
-      - name: Login to GitHub Container Registry
+      - name: "Login to GitHub container registry"
         uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: LS-DYNA Keyword server activation
+      - name: "Pull and start LS-DYNA keyword server"
         run: |
           docker pull ghcr.io/ansys/ls-pre:latest
           docker run -d --name kw_server -p 50051:50051 ghcr.io/ansys/ls-pre:latest && echo "Keyword server active on port 50051."
 
-      - name: Install ansys-dyna-core (with test requirements)
+      - name: "Install package dependencies"
         run: |
           pip install -e .[tests]
 
-      - name: Run tests
+      - name: "Run tests"
         run: |
           pytest
 
-      - name: Extract the server logs
+      - name: "Extract the server logs"
         if: always()
         run: |
           docker logs kw_server > server_output.txt
 
-      - name: Upload the server logs
+      - name: "Upload the server logs"
         if: always()
         uses: actions/upload-artifact@v3
         with:
           name: server_output.txt
           path: server_output.txt
 
-      - name: Upload coverage results
+      - name: "Upload coverage results"
         uses: actions/upload-artifact@v3
         with:
           name: coverage-html
           path: .cov/html
           retention-days: 7
 
-  package:
-    name: Package library
-    needs: [docs, tests]
+  build-library:
+    name: "Build library"
+    needs: [doc, tests]
     runs-on: ubuntu-latest
     steps:
-      - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v4
+      - uses: ansys/actions/build-library@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
   release:
     name: Release project
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [package]
+    needs: [build-library]
     runs-on: ubuntu-latest
     steps:
-      - name: Release to the private PyPI repository
+      - name: "Release to the private PyPI repository"
         uses: ansys/actions/release-pypi-private@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}
 
-      - name: Release to GitHub
+      - name: "Release to GitHub"
         uses: ansys/actions/release-github@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
-  upload_dev_docs:
-    name: Upload dev documentation
+  doc-deploy-dev:
+    name: "Deploy development documentation"
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
-    needs: [package]
+    needs: [build-library]
     steps:
-      - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v4
+      - uses: ansys/actions/doc-deploy-dev@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
-  upload_docs_release:
-    name: Upload release documentation
+  doc-deploy-stable:
+    name: "Deploy stable documentation"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
     needs: [release]
     steps:
-      - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v4
+      - uses: ansys/actions/doc-deploy-stable@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}