FEAT: pre-release quick tech review (#18)

* FEAT: Align contributors to commits in repo

* FEAT: Workflow cleanup

* Allowing smoke tests when pushing to main.

* FIX: remove timeout

* removing style

* removing timeout too

* FIX: No need to dive inside tests folder

* FEAT: additional pre-commit hooks

* FEAT: Adding CONTRIBUTING

* FEAT: dependabot

* MAINT: stop concurrent workflows

* DOCS: minor edits

* Rename API.rst to api.rst

* MAINT: tool value alignments (line-length)

* MAINT: pyproject.toml values

* FIX: reduce dependabot frequency

* FIX: refer to single version value

---------

Co-authored-by: German <[email protected]>

Author: RobPasMue

.github/dependabot.yml

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

.github/workflows/approver.yml

@@ -1,7 +1,7 @@
 name: Approve PRs
 on:
   workflow_dispatch:
-  issue_comment:                                     
+  issue_comment:
     types: [created, edited]
 
 jobs:

.github/workflows/ci_cd.yml

@@ -15,29 +15,22 @@ env:
   PACKAGE_NAMESPACE: 'ansys.tools.path'
   DOCUMENTATION_CNAME: 'path.tools.docs.pyansys.com'
 
-jobs:
-  style:
-    name: Code style
-    runs-on: ubuntu-latest
-    steps:
-      - name: PyAnsys code style checks
-        uses: pyansys/actions/code-style@v4
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 
+jobs:
   smoke-tests:
     name: "Build and smoke tests"
     runs-on: ${{ matrix.os }}
-    needs: [style]
-    if: github.ref != 'refs/heads/main'
-    timeout-minutes: 20
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
         # Only perform wheelhouse builds for macOS when releasing
-        should-release: 
+        should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
           - should-release: false
@@ -50,12 +43,11 @@ jobs:
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
-          
+
   build-tests:
     name: Build and Testing
     runs-on: ubuntu-latest
     needs: [smoke-tests]
-    timeout-minutes: 20
     container:
       image: ghcr.io/pyansys/mapdl:v22.2-ubuntu
       options: "-u=0:0 --entrypoint /bin/bash"
@@ -78,7 +70,6 @@ jobs:
 
       - name: Unit testing
         run: |
-          cd tests  # so we're testing the install, not local
           python -m pytest -vx --cov=${{ env.PACKAGE_NAMESPACE }} --cov-report=term --cov-report=xml:.cov/coverage.xml --cov-report=html:.cov/html
 
       - name: Upload coverage reports to Codecov
@@ -87,7 +78,7 @@ jobs:
           files: .cov/coverage.xml
 
   docs-style:
-    name: PyAnsys documentation style check using Vale
+    name: Documentation style check
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks

.pre-commit-config.yaml

@@ -31,6 +31,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

AUTHORS.md

@@ -2,4 +2,8 @@
 
 ## Project Lead
 
-*   [German Martinez Ayuso](https://github.com/germa89)
+*   [German Martinez Ayuso](https://github.com/germa89)
+
+## Contributors
+
+*   [Roberto Pastor Muela](https://github.com/RobPasMue)

CONTRIBUTING.md

@@ -1,2 +1,16 @@
-# Contributing 
+# Contributing
 
+We absolutely welcome any code contributions and we hope that this
+guide will facilitate an understanding of the ``ansys-tools-path`` code
+repository. It is important to note that while the ``ansys-tools-path`` software
+package is maintained by ANSYS and any submissions will be reviewed
+thoroughly before merging, we still seek to foster a community that can
+support user questions and develop new features to make this software
+a useful tool for all users. As such, we welcome and encourage any
+questions or submissions to this repository.
+
+For contributing to this project, please refer to the [PyAnsys Developer's Guide].
+Further information about contributing to ``ansys-tools-path`` can be found in [Contributing].
+
+[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html
+[Contributing]: https://path.tools.docs.pyansys.com/dev/contributing.html

README.rst

@@ -104,7 +104,7 @@ You need to follow these steps:
 #. Install the project in editable mode:
 
    .. code:: bash
-    
+
       python -m pip install --editable ansys-tools-path
 
 

doc/make.bat

@@ -30,7 +30,7 @@ if errorlevel 9009 (
 goto end
 
 :clean
-rmdir /s /q %BUILDDIR% > /NUL 2>&1 
+rmdir /s /q %BUILDDIR% > /NUL 2>&1
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
 goto end
 

doc/source/_templates/sidebar-nav-bs.html

@@ -1,7 +1,7 @@
 .. _ref_api:
 
 API
-========
+===
 
 .. currentmodule:: ansys.tools.path
 
@@ -11,4 +11,4 @@ API
    find_ansys
    get_available_ansys_installations
    change_default_ansys_path
-   save_ansys_path
+   save_ansys_path