maint: technical review (#31)

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

.devcontainer/devcontainer.json

@@ -26,7 +26,7 @@
 	// I am using postStartCommand because postCreateCommand happens before the .gitconfig
 	// file is copied in, preventing access to ansys-common-variableinterop for me. This
 	// has the side-effect of running it every time you start the container, which
-	// might not be what we want? 
+	// might not be what we want?
 	"postStartCommand": "git config --list && poetry -vv install -E dev"
 
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-exclude = venv, __init__.py, doc/_build
+exclude = venv, __init__.py, doc/_build, .venv
 select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
 count = True
 max-complexity = 10

.github/dependabot.yml

@@ -3,5 +3,12 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
-    versioning-strategy: "lockfile-only"
+      interval: "weekly"
+    labels:
+      - "maintenance"
+      - "dependencies"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/cicd.yml

@@ -0,0 +1,147 @@
+# check spelling, codestyle
+name: GitHub CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    tags:
+      - "*"
+    branches:
+      - main
+
+env:
+  DOCUMENTATION_CNAME: 'engineeringworkflow.docs.pyansys.com'
+  MAIN_PYTHON_VERSION: '3.11'
+  PACKAGE_NAME: 'ansys-engineeringworkflow-api'
+  PACKAGE_NAMESPACE: 'ansys.engineeringworkflow.api'
+
+jobs:
+  code-style:
+    name: "Code style"
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys code style checks
+        uses: ansys/actions/code-style@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  doc-style:
+    name: "Documentation Style Check"
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys documentation style checks
+        uses: ansys/actions/doc-style@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  smoke-tests:
+    name: "Build and Smoke tests"
+    runs-on: ${{ matrix.os }}
+    needs: [code-style]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+        should-release:
+          - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
+        exclude:
+          - should-release: false
+            os: macos-latest
+
+    steps:
+      - name: Build wheelhouse and perform smoke test
+        uses: ansys/actions/build-wheelhouse@v5
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+
+  build-test:
+    name: "Build and unit testing"
+    runs-on: ubuntu-latest
+    needs: [smoke-tests]
+    steps:
+      - name: Run pytest
+        uses: ansys/actions/tests-pytest@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          pytest-extra-args: -v --durations=10 --maxfail=10 --cov=${{ env.PACKAGE_NAMESPACE }} --cov-report=xml:coverage.xml --cov-report=html --cov-report term
+
+      - name: "Upload coverage to Codecov"
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+
+      - name: "Upload coverage artifacts"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-html
+          path: htmlcov
+
+  doc-build:
+    name: "Documentation building"
+    runs-on: ubuntu-latest
+    needs: [doc-style]
+    steps:
+      - name: "Run Ansys documentation building action"
+        uses: ansys/actions/doc-build@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  package:
+    name: Package library
+    needs: [doc-build, build-test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build library source and wheel artifacts
+        uses: ansys/actions/build-library@v5
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  doc-deploy-dev:
+    name: "Deploy development documentation"
+    # Deploy development only when merging to main
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: [package]
+    steps:
+      - name: "Deploy the latest documentation"
+        uses: ansys/actions/doc-deploy-dev@v5
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  release:
+    name: "Release project to public PyPI and GitHub"
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs:  [package]
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: "Release to the public PyPI repository"
+      uses: ansys/actions/release-pypi-public@v5
+      with:
+        library-name: ${{ env.PACKAGE_NAME }}
+        twine-username: "__token__"
+        twine-token: ${{ secrets.PYPI_TOKEN }}
+
+    - name: "Release to GitHub"
+      uses: ansys/actions/release-github@v5
+      with:
+        library-name: ${{ env.PACKAGE_NAME }}
+
+  doc-deploy-stable:
+    name: "Deploy stable documentation"
+    # Deploy release documentation when creating a new tag
+    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@v5
+        with:
+            cname: ${{ env.DOCUMENTATION_CNAME }}
+            token: ${{ secrets.GITHUB_TOKEN }}