FEAT: uploading dependencies using pip freeze (#229)

* FEAT: pre-commit hooks

* FEAT: upload dependencies as a list

* WIP: attempt to upload all deps (dry-run)

* FIX: Specifically providing artifact names

* FEAT: removing dry run

* FEAT: moving artifact (without .txt)

Author: RobPasMue

.github/workflows/ci-build.yml

@@ -113,6 +113,18 @@ jobs:
           python-version: ${{ matrix.python-version }}
           target: "all"
 
+      - name: List dependencies (pip freeze)
+        run: |
+          pip freeze > all-deps-${{ runner.os }}-${{ matrix.python-version }}.txt
+          cat all-deps-${{ runner.os }}-${{ matrix.python-version }}.txt
+
+      - name: Upload dependencies list
+        uses: actions/upload-artifact@v3
+        with:
+          name: all-deps-${{ runner.os }}-${{ matrix.python-version }}
+          path: all-deps-${{ runner.os }}-${{ matrix.python-version }}.txt
+          retention-days: 7
+
   docs-build:
     name: Building Documentation
     runs-on: ubuntu-latest
@@ -160,3 +172,4 @@ jobs:
         uses: pyansys/actions/release-github@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
+          additional-artifacts: 'all-deps-Linux-3.8 all-deps-Linux-3.9 all-deps-Linux-3.10 all-deps-Linux-3.11 all-deps-Windows-3.8 all-deps-Windows-3.9 all-deps-Windows-3.10 all-deps-Windows-3.11 all-deps-macOS-3.8 all-deps-macOS-3.9 all-deps-macOS-3.10 all-deps-macOS-3.11'

.pre-commit-config.yaml

@@ -33,6 +33,8 @@ repos:
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
+  - id: check-yaml
+  - id: trailing-whitespace
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema

doc/source/getting_started.rst

@@ -47,7 +47,7 @@ Before installing ``pyansys`` in user mode, ensure that you have the latest
 version of `pip <https://pypi.org/project/pip/>`_ with:
 
 .. code:: bash
-   
+
     python -m pip install -U pip
 
 Then, install ``pyansys`` with:

doc/source/links.rst

@@ -61,7 +61,7 @@
 .. _What_is_the_Windows_Subsystem_for_Linux: https://docs.microsoft.com/en-us/windows/wsl/about
 .. _open_port_windows_10: https://answers.microsoft.com/en-us/windows/forum/all/how-to-open-port-in-windows-10-firewall/f38f67c8-23e8-459d-9552-c1b94cca579a/
 .. _disabling_firewall_on_wsl: https://github.com/cascadium/wsl-windows-toolbar-launcher#firewall-rules
-.. _article_good_unit_test: https://stackoverflow.com/questions/61400/what-makes-a-good-unit-test 
+.. _article_good_unit_test: https://stackoverflow.com/questions/61400/what-makes-a-good-unit-test
 .. _vscode_attach_to_container: https://code.visualstudio.com/docs/devcontainers/attach-container
 .. _ubuntu_firewall: https://ubuntu.com/server/docs/security-firewall