Refactor nox task names (#275)

Author: Nicoretti

.github/workflows/checks.yml

@@ -59,7 +59,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Run lint
-        run: poetry run nox -s lint
+        run: poetry run nox -s lint:code
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.4.0
@@ -87,7 +87,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Run type-check
-        run: poetry run nox -s type-check
+        run: poetry run nox -s lint:typing
 
   Security:
     name: Security Checks (Python-${{ matrix.python-version }})
@@ -108,7 +108,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Run security linter
-        run: poetry run nox -s security
+        run: poetry run nox -s lint:security
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.4.0
@@ -139,7 +139,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Run Tests and Collect Coverage
-        run: poetry run nox -s coverage -- -- --db-version ${{ matrix.exasol-version }}
+        run: poetry run nox -s test:coverage -- -- --db-version ${{ matrix.exasol-version }}
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.4.0

.github/workflows/report.yml

@@ -35,7 +35,7 @@ jobs:
           cp security-python3.9/.security.json ../
 
       - name: Generate Report
-        run: poetry run nox -s report -- -- --format json | tee metrics.json
+        run: poetry run nox -s project:report -- -- --format json | tee metrics.json
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.4.0
@@ -46,7 +46,7 @@ jobs:
       - name: Generate GitHub Summary
         run: |
           echo -e "# Summary\n" >> $GITHUB_STEP_SUMMARY
-          poetry run nox -s report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
+          poetry run nox -s project:report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
           echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
           poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
           echo  -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY

doc/changes/unreleased.md

@@ -3,10 +3,23 @@
 ## 🚨 Breaking Changes
 
 * Dropped python 3.8 support
-* Changed names of Documentation related nox tasks
-    - `build-docs` -> `docs:build`
-    - `open-docs` -> `docs:open`
-    - `clean-docs` -> `docs:clean`
+* Changed names of all nox tasks
+
+    | Old Name           | New Name               | Description                                                    |
+    |--------------------|------------------------|----------------------------------------------------------------|
+    | fix                | project:fix            | Runs all automated fixes on the code base                      |
+    | check              | project:check          | Runs all available checks on the project                       |
+    | report             | project:report         | Collects and generates metrics summary for the workspace       |
+    | unit-tests         | test:unit              | Runs all unit tests                                            |
+    | integration-tests  | test:integration       | Runs all the integration tests                                 |
+    | coverage           | test:coverage          | Runs all tests (unit + integration) and reports the code coverage |
+    | lint               | lint:code              | Runs the static code analyzer on the project                   |
+    | type-check         | lint:typing            | Runs the type checker on the project                           |
+    | security           | lint:security          | Runs the security linter on the project                        |
+    | build-build        | docs:build             | Builds the project documentation                               |
+    | open-open          | docs:open              | Opens the built project documentation                          |
+    | clean-docs         | docs:clean             | Removes the documentations build folder                        |
+    | prepare-release    | release:prepare        | Prepares the project for a new release                         |
 
 ## ✨ Added
 

doc/developer_guide/development.rst

@@ -17,7 +17,7 @@ This can be achieved by running the following command:
 
 .. code-block:: shell
 
-   nox -s prepare-release -- <major>.<minor>.<patch>
+   nox -s release:prepare -- <major>.<minor>.<patch>
 
 Replace `<major>`, `<minor>`, and `<patch>` with the appropriate version numbers.
 Once the PR is successfully merged, the release can be triggered (see next section).

doc/metrics.rst

@@ -84,7 +84,7 @@ Tooling
 Projects
 ________
 
-Projects can run the nox task :code:`nox -s report` to generate their project metrics if they are using the :code:`exasol-toolbox`.
+Projects can run the nox task :code:`nox -s project:report` to generate their project metrics if they are using the :code:`exasol-toolbox`.
 
 
 Development

doc/user_guide/getting_started.rst

@@ -77,7 +77,7 @@ Execute the unit tests of the project:
 
 .. code-block:: shell
 
-    nox -s unit-tests
+    nox -s test:unit
 
 
 .. _existing:
@@ -184,17 +184,20 @@ You are ready to use the toolbox. With *nox -l* you can list all available tasks
     $ nox -l
     Sessions defined in <PATH_TO_YOUR_PROJECT>/noxfile.py:
 
-    * fix -> Runs all automated fixes on the code base
-    - check -> Runs all available checks on the project
-    - lint -> Runs the linter on the project
-    - type-check -> Runs the type checker on the project
-    - unit-tests -> Runs all unit tests
-    - integration-tests -> Runs the all integration tests
-    - coverage -> Runs all tests (unit + integration) and reports the code coverage
+    * project:fix -> Runs all automated fixes on the code base
+    - project:check -> Runs all available checks on the project
+    - project:report -> Collects and generates metrics summary for the workspace
+    - test:unit -> Runs all unit tests
+    - test:integration -> Runs the all integration tests
+    - test:coverage -> Runs all tests (unit + integration) and reports the code coverage
+    - lint:code -> Runs the static code analyzer on the project
+    - lint:typing -> Runs the type checker on the project
+    - lint:security -> Runs the security linter on the project
+    - docs:multiversion -> Builds the multiversion project documentation
     - docs:build -> Builds the project documentation
     - docs:open -> Opens the built project documentation
     - docs:clean -> Removes the documentations build folder
-    - report -> Collects and generates a metrics summary for the workspace
+    - release:prepare -> Prepares the project for a new release.
 
     sessions marked with * are selected, sessions marked with - are skipped.
 

exasol/toolbox/nox/_documentation.py

@@ -38,7 +38,7 @@ def _build_multiversion_docs(session: nox.Session, config: Config) -> None:
 
 @nox.session(name="docs:multiversion", python=False)
 def build_multiversion(session: Session) -> None:
-    """Builds the project documentation"""
+    """Builds the multiversion project documentation"""
     _build_multiversion_docs(session, PROJECT_CONFIG)
 
 

exasol/toolbox/nox/_format.py

@@ -33,7 +33,7 @@ def _pyupgrade(session: Session, files: Iterable[str]) -> None:
     )
 
 
-@nox.session(python=False)
+@nox.session(name="project:fix", python=False)
 def fix(session: Session) -> None:
     """Runs all automated fixes on the code base"""
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]

exasol/toolbox/nox/_lint.py

@@ -65,21 +65,21 @@ def _security_lint(session: Session, files: Iterable[str]) -> None:
     )
 
 
-@nox.session(python=False)
+@nox.session(name="lint:code", python=False)
 def lint(session: Session) -> None:
-    """Runs the linter on the project"""
+    "Runs the static code analyzer on the project"
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
     _pylint(session, py_files)
 
 
-@nox.session(name="type-check", python=False)
+@nox.session(name="lint:typing", python=False)
 def type_check(session: Session) -> None:
     """Runs the type checker on the project"""
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
     _type_check(session, py_files)
 
 
-@nox.session(name="security", python=False)
+@nox.session(name="lint:security", python=False)
 def security_lint(session: Session) -> None:
     """Runs the security linter on the project"""
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]

exasol/toolbox/nox/_metrics.py

@@ -13,7 +13,7 @@
 from noxconfig import PROJECT_CONFIG
 
 
-@nox.session(name="report", python=False)
+@nox.session(name="project:report", python=False)
 def report(session: Session) -> None:
     """
     Collects and generates metrics summary for the workspace
@@ -28,11 +28,12 @@ def report(session: Session) -> None:
                 * :code:`rm .coverage .lint.txt`
 
         * Run the following targets:
-            - :code:`nox -s coverage`
-            - :code:`nox -s lint`
+            - :code:`nox -s test:coverage`
+            - :code:`nox -s lint:code`
+            - :code:`nox -s lint:security`
     """
     formats = tuple(fmt.name.lower() for fmt in Format)
-    usage = "nox -s report -- [options]"
+    usage = "nox -s project:report -- [options]"
     parser = argparse.ArgumentParser(
         description="Generates status report for the project", usage=usage
     )
@@ -51,7 +52,7 @@ def report(session: Session) -> None:
     )
     if not all(file.exists() for file in required_files):
         session.error(
-            "Please make sure you run the `coverage`, `security` and the `lint` target first"
+            "Please make sure you run the `test:coverage`, `lint:security` and the `lint:code` target first"
         )
     sha1 = str(
         session.run("git", "rev-parse", "HEAD", external=True, silent=True)