CI: Add job for min versions (#39)

adrien-berchet · web-flow · commit ce9ea3e6af83 · 2023-03-01T15:19:54.000+01:00
diff --git a/.auto-changelog-template.hbs b/.auto-changelog-template.hbs
@@ -9,6 +9,7 @@ Introduction
 • The types feat:, fix:, chore:, docs:, refactor:, test:, style:, perf: must be at the beginning of the commit subject with an : on end.
    • They can optionally have a scope set to outline the module or component that is affected eg feat(bldAssess):
 • There is a short hash on the end of every commit that is currently commented out so that change log did not grow too long (due to some system's file size limitations).  You can uncomment if you wish [`{{shorthash}}`]({{href}})
+
 Example Definitions
 • feat: A new feature
 • fix: A bug fix
@@ -30,6 +31,10 @@ Example Definitions
     "replaceText": {
       "([bB]reaking:)": "",
       "([bB]reaking change:)": "",
+      "(^[bB]uild:)": "",
+      "(^[bB]uild\\()": "\\(",
+      "(^[dD]eprecate:)": "",
+      "(^[dD]eprecate\\()": "\\(",
       "(^[fF]eat:)": "",
       "(^[fF]eat\\()": "\\(",
       "(^[fF]ix:)": "",
@@ -59,7 +64,7 @@ Example Definitions
  \s = whitespace
  . = any character except newline
  | = or
- [aA] = charcter a or character A
+ [aA] = character a or character A
  --}}
 
 
@@ -81,13 +86,21 @@ Example Definitions
     - {{#if commit.breaking}}**Breaking change:** {{/if}}{{commit.subject}}{{#each fixes}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}}){{/each}}
   {{/each}}
 
-  {{! List commits with 'breaking:' or 'Breaking change:' anywhere in the message under a heading}}
+  {{! List merge commits with 'breaking:' or 'Breaking change:' anywhere in the message under a heading}}
   {{#commit-list merges heading='### Breaking Changes :warning:' message='[bB]reaking [cC]hange:|[bB]reaking:' exclude='\[skip-changelog\]'}}
     - {{message}} @{{author}}  <!--[`#{{id}}`]({{href}}) -->
   {{/commit-list}}
 
   {{! List commits organised under a heading, but not those already listed in the breaking section }}
-      {{#commit-list merges heading='### New Features' message='^[fF]eat:|[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+      {{#commit-list merges heading='### Build' message='^[bB]uild:|^[bB]uild\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+        - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
+      {{/commit-list}}
+
+      {{#commit-list merges heading='### Deprecated Features' message='^[dD]eprecate:|^[dD]eprecate\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+        - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
+      {{/commit-list}}
+
+      {{#commit-list merges heading='### New Features' message='^[fF]eat:|^[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
@@ -123,7 +136,7 @@ Example Definitions
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
-      {{#commit-list merges heading='### Uncategorized Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
+      {{#commit-list merges heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild\(|^[dD]eprecate:|^[dD]eprecate\(|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
@@ -133,7 +146,15 @@ Example Definitions
   {{/commit-list}}
 
   {{! List commits organised under a heading, but not those already listed in the breaking section }}
-      {{#commit-list commits heading='### New Features' message='^[fF]eat:|[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+      {{#commit-list commits heading='### Build' message='^[bB]uild:|^[bB]uild\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+        - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
+      {{/commit-list}}
+
+      {{#commit-list commits heading='### Deprecated Features' message='^[dD]eprecate:|^[dD]eprecate\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
+        - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
+      {{/commit-list}}
+
+      {{#commit-list commits heading='### New Features' message='^[fF]eat:|^[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
         - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
       {{/commit-list}}
 
@@ -169,7 +190,7 @@ Example Definitions
         - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
       {{/commit-list}}
 
-      {{#commit-list commits heading='### Uncategorized Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
+      {{#commit-list commits heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild\(|^[dD]eprecate:|^[dD]eprecate\(|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
         - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
       {{/commit-list}}
 
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,6 +1,6 @@
 # Changes here will be overwritten by Copier
 
-_commit: 0.1.26
+_commit: 0.1.39
 _src_path: git@bbpgitlab.epfl.ch:neuromath/python-template.git
 author_email: ''
 author_name: Blue Brain Project, EPFL
@@ -21,6 +21,7 @@ ssh_url: git@github.com:BlueBrain/data-validation-framework.git
 support_py37: false
 team_name: ''
 tracker_url: https://github.com/BlueBrain/data-validation-framework/issues
+use_pyproject_toml: false
 version: 0.6.2
 
 # End of Copier answers
diff --git a/.flake8 b/.flake8
@@ -1,5 +1,7 @@
 [flake8]
 ignore =
-	E203,  # E203: whitespace before ':'
-	W503  # W503: line break before binary operator
+	# E203: whitespace before ':'
+	E203,
+	# W503: line break before binary operator
+	W503
 max-line-length = 100
diff --git a/.github/workflows/run-tox.yml b/.github/workflows/run-tox.yml
@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
   build:
@@ -13,6 +14,12 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
+        min_versions: ["min_versions", "latest_versions"]
+        exclude:
+          - min_versions: "min_versions"
+        include:
+          - python-version: "3.8"
+            min_versions: "min_versions"
 
     steps:
     - uses: actions/checkout@v3
@@ -34,16 +41,21 @@ jobs:
           .tox
           ~/.cache/pre-commit
         key: ${{ runner.os }}-${{ matrix.python-version }}-${{ steps.date.outputs.date }}-${{ hashFiles('setup.py') }}-${{ hashFiles('.pre-commit-config.yaml') }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools
-        pip install tox-gh-actions
     - name: Clear results in tox environments
       run: |
         rm -rf .tox/*/tmp
-    - name: Run tox
+    - name: Run tox with latest versions
+      if: ${{ matrix.min_versions == 'latest_versions' }}
       run: |
+        python -m pip install --upgrade pip setuptools
+        pip install tox-gh-actions
         tox
+    - name: Run tox with min versions
+      if: ${{ matrix.min_versions == 'min_versions' }}
+      run: |
+        python -m pip install --upgrade pip setuptools
+        pip install tox
+        tox run -e min_versions
     - name: JUnit Report Action
       uses: mikepenz/action-junit-report@v3
       if: always() # always run even if the previous step fails
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,7 +2,7 @@ default_language_version:
   python: python3.8
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -13,31 +13,31 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.0.0
+    rev: v9.4.0
     hooks:
         - id: commitlint
           stages:
             - commit-msg
           additional_dependencies: ['conventional-changelog-conventionalcommits']
   - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.12.0
     hooks:
       - id: black
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.2.2
     hooks:
       - id: codespell
         args: ["-x", ".codespellignorelines"]
   - repo: https://github.com/PyCQA/pydocstyle
-    rev: 6.1.1
+    rev: 6.3.0
     hooks:
       - id: pydocstyle
-        additional_dependencies: ["toml"]
+        additional_dependencies: ["tomli"]
   - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+    rev: 6.0.0
     hooks:
       - id: flake8
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -20,11 +20,13 @@ module.exports = {
 				'Build',
 				'Chore',
 				'CI',
+				'Deprecate',
 				'Docs',
 				'Feat',
 				'Fix',
 				'Perf',
 				'Refactor',
+				'Release',
 				'Revert',
 				'Release',
 				'Style',
@@ -101,6 +103,11 @@ module.exports = {
 						title: 'Release',
 						emoji: '🎉',
 					},
+					Deprecate: {
+						description: 'Deprecate a feature',
+						title: 'Deprecations',
+						emoji: '🗳',
+					},
 				},
 			},
 			scope: {
diff --git a/data_validation_framework/result.py b/data_validation_framework/result.py
@@ -28,7 +28,6 @@ class ValidationResult(dict):
     """
 
     def __init__(self, is_valid, ret_code=None, comment=None, exception=None, **kwargs):
-        """ """
         if ret_code is None:
             if is_valid:
                 ret_code = 0
diff --git a/package.json b/package.json
@@ -10,6 +10,8 @@
       "(^[cC]hore\\((.*)\\): ?)": "\\($2\\)",
       "(^[cC][iI]: ?)": "",
       "(^[cC][iI]\\((.*)\\): ?)": "\\($2\\)",
+      "(^[dD]eprecate: ?)": "",
+      "(^[dD]eprecate\\((.*)\\): ?)": "\\($2\\)",
       "(^[dD]ocs: ?)": "",
       "(^[dD]ocs\\((.*)\\): ?)": "\\($2\\)",
       "(^[fF]eat: ?)": "",
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,20 +1,21 @@
-# SETUPTOOLS
 [build-system]
 requires = [
-    "setuptools>=42",
-    "wheel",
-    "setuptools_scm[toml]>=3.4",
+    "setuptools>=45",
+    "setuptools_scm[toml]>=6.2",
 ]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
 
-# BLACK
 [tool.black]
 line-length = 100
 target-version = [
     "py38",
     "py39",
+    "py310",
+    "py311",
 ]
 
-# PYDOCSTYLE
 [tool.pydocstyle]
 # ignore the following:
 #   - D105: Missing docstring in magic method
@@ -25,13 +26,11 @@ add-ignore = [
 ]
 convention = "google"
 
-# ISORT
 [tool.isort]
 profile = "black"
 line_length = 100
 force_single_line = true
 
-# PYTEST
 [tool.pytest.ini_options]
 testpaths = [
     "tests",
diff --git a/setup.py b/setup.py
@@ -7,11 +7,11 @@
 reqs = [
     "luigi>=3.1",
     "luigi-tools>=0.0.18",
-    "numpy<1.24",
-    "pandas",
-    "rst2pdf",
-    "sphinx>=3,<6",
-    "tqdm",
+    "numpy>=1.21",
+    "pandas>=1.3",
+    "rst2pdf>=0.99",
+    "sphinx>=4,<6",
+    "tqdm>=4.40",
 ]
 doc_reqs = [
     "m2r2",
@@ -20,11 +20,10 @@
 ]
 test_reqs = [
     "diff_pdf_visually>=1.6.2",
-    "pause",
-    "pytest",
-    "pytest-cov",
-    "pytest-html",
-    "rst2pdf>=0.99",
+    "pause>=0.2",
+    "pytest>=7",
+    "pytest-cov>=3",
+    "pytest-html>=3.1",
 ]
 
 setup(
@@ -41,10 +40,6 @@
     license="Apache License 2.0",
     packages=find_namespace_packages(include=["data_validation_framework*"]),
     python_requires=">=3.8",
-    use_scm_version=True,
-    setup_requires=[
-        "setuptools_scm",
-    ],
     install_requires=reqs,
     extras_require={
         "docs": doc_reqs,
diff --git a/tests/test_task.py b/tests/test_task.py
@@ -1947,7 +1947,7 @@ def inputs(self):
             return TestWorkflow
 
         def test_specifications(self, TestTask, TestTask_Specifications):
-            """Test spcifications different from the docstring of the task."""
+            """Test specifications different from the docstring of the task."""
             assert TestTask(dataset_df="", result_path="").__specifications__ == (
                 "A test validation task."
             )
diff --git a/tox.ini b/tox.ini
