v23.10.3

CHANGES.md

@@ -1,5 +1,13 @@
 # Changelog
 
+**23.10.3 (2023-10-26)**
+* Added custom_installation metadata (renamed from `installation`)
+* Added additional_information metadata
+* Added flag for rendering migration related things in metadata
+* Added migration validator to GitHub actions
+* Removed HTML coverage report in GitHub actions
+* Updated readthedocs.yml template
+
 **23.10.2 (2023-10-20)**
 * Add coverage check to CI pipeline
 * Enforced 100% coverage and added badge

ambient_package_update/__init__.py

@@ -1,3 +1,3 @@
 """Ambient package update tool for clean and swift maintenance"""
 
-__version__ = '23.10.2'
+__version__ = '23.10.3'

ambient_package_update/metadata/package.py

@@ -14,6 +14,7 @@ class PackageMetadata:
     authors: list[PackageAuthor]
     development_status: str
     readme_content: ReadmeContent
+    has_migrations: bool
     dependencies: list[str]
     supported_django_versions: list[str]
     supported_python_versions: list[str]

ambient_package_update/metadata/readme.py

@@ -6,4 +6,5 @@
 class ReadmeContent:
     tagline: str
     content: Optional[str] = None
-    installation: Optional[str] = None
+    custom_installation: Optional[str] = None
+    additional_installation: Optional[str] = None

ambient_package_update/templates/.github/workflows/ci.yml.tpl

@@ -48,7 +48,9 @@ jobs:
       - name: Run Tests
         env:
           TOXENV: django${% raw %}{{ matrix.django-version }}{% endraw %}
-        run: tox
+        run: tox{% if has_migrations %}
+      - name: Validate migration integrity
+        run: python manage.py makemigrations --check --dry-run{% endif %}
       - name: Upload coverage data
         uses: actions/upload-artifact@v3
         with:
@@ -76,13 +78,5 @@ jobs:
 
       - name: Combine coverage and fail if it's <100%
         run: |
-          # python -m coverage combine
           python -m coverage html --skip-covered --skip-empty
           python -m coverage report --fail-under=100
-
-      - name: Upload HTML report
-        if: ${% raw %}{{ failure() }}{% endraw %}
-        uses: actions/upload-artifact@v3
-        with:
-          name: html-report
-          path: htmlcov

ambient_package_update/templates/.readthedocs.yaml.tpl

@@ -0,0 +1,28 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

ambient_package_update/templates/README.md.tpl

@@ -16,8 +16,8 @@
 
 ## Installation
 
-{% if readme_content.installation %}
-  {{ readme_content.installation }}
+{% if readme_content.custom_installation %}
+{{ readme_content.custom_installation }}
 {% else %}
 - Install the package via pip:
 
@@ -35,6 +35,14 @@
         '{{ package_name }}',
     )
      ````
+
+{% if has_migrations %}
+- Apply migrations by running:
+
+  `python ./manage.py migrate`
+{% endif %}
+
+{% if readme_content.additional_installation %}{{ readme_content.additional_installation }}{% endif %}
 {% endif %}
 
 ## Contribute

pyproject.toml

@@ -25,9 +25,14 @@ classifiers = [
 ]
 dynamic = ["version", "description"]
 license = {"file" = "LICENSE.md"}
-dependencies = [
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    # Rendering
     'typer~=0.9',
     'Jinja2~=3.1',
+    # Deploy
     'flit~=3.9',
     'keyring~=24.2',
     # Linting