Update documentation

Author: ArBridgeman

doc/changes/unreleased.md

@@ -1,17 +1,32 @@
 # Unreleased
 
-Verification of the Python/Exasol version format of the config by adding a BaseConfig class. To Use:
-    
-    #Use
-        Project_Config = BaseConfig()
-    #modify
-        Project_Config = BaseConfig(python_versions=["3.12"])
-    #expand
-        class ProjectConfig(BaseConfig):
-            extra_data: list[str] = ["data"]
-
-        Project_Config = ProjectConfig()
+## BaseConfig class for PTB attributes
+
+The BaseConfig class was introduced in this version. This class is used to consolidate
+the attributes needed for the PTB's functionalities into an inherited object which can
+be expanded upon as needed. At this point, the BaseConfig class includes
+``python_versions``, ``exasol_versions``, and ``create_major_version_tags``. Users of
+the PTB should update their ``noxconfig.py`` to start using this feature.
+
+```python
+# noxconfig.py
+from exasol.toolbox.config import BaseConfig
+
+
+# existing Config should inherit from BaseConfig
+class Config(BaseConfig):
+    # if present, remove any attributes already in the BaseConfig from the added attributes
+    ...
+
+
+# if no overlapping attributes with `BaseConfig` were present in `Config`, then this is unmodified.
+PROJECT_CONFIG = Config()
+# if no overlapping attributes with `BaseConfig` were present in `Config`, then this should be modified.
+PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_major_version_tags=True)
+```
 
 ## Feature
 
-#465: Create BaseConfig class
+* #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
+  growing functionalities
+    * Started with ``python_versions`` and ``exasol_versions``

exasol/toolbox/config.py

@@ -51,6 +51,10 @@ class BaseConfig(BaseModel):
         default=("7.1.9",),
         description="Exasol versions to use in running CI workflows for integration tests using the DB",
     )
+    create_major_version_tags: bool = Field(
+        default=False,
+        description="If true, creates also the major version tags (v*) automatically",
+    )
     model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)
 
     @computed_field  # type: ignore[misc]

noxconfig.py

@@ -68,7 +68,6 @@ class Config(BaseConfig):
     # format, and it is not resolved with from __future__ import annotations. pyupgrade
     # will keep switching Optional[str] to str | None leading to issues.
     pyupgrade_args: Iterable[str] = ("--py39-plus", "--keep-runtime-typing")
-    create_major_version_tags = True
 
 
-PROJECT_CONFIG = Config()
+PROJECT_CONFIG = Config(create_major_version_tags=True)

project-template/{{cookiecutter.repo_name}}/noxconfig.py

@@ -20,7 +20,5 @@ class Config(BaseConfig):
     pyupgrade_args: Iterable[str] = (
     "--py{{cookiecutter.python_version_min | replace('.', '')}}-plus",)
     plugins: Iterable[object] = ()
-    create_major_version_tags = False
-
 
 PROJECT_CONFIG = Config()