Updated docs styling and testing dependencies (#18)

* Initialize template from version 80d7f1ffae8953435935d7f1ef7d1e526a4be755

* Update template to version 2794ea47b0220081dc869d01199ee490dda00762

* update lockfiles

* Bump version and add release notes

.circleci/config.yml

@@ -8,9 +8,8 @@ orbs:
         docker:
           - image: opus10/circleci-python-library:2024-04-17
             environment:
-              # Ensure makefile commands are not wrapped in "docker-compose run"
+              # Ensure makefile commands are not wrapped in "docker compose run"
               EXEC_WRAPPER: ''
-              TOX_PARALLEL_NO_SPINNER: 1
               DATABASE_URL: postgres://root@localhost/circle_test?sslmode=disable
           - image: cimg/postgres:<<parameters.pg_version>>
             environment:
@@ -40,14 +39,14 @@ jobs:
   test_pg_min:
     executor:
       name: opus10/python
-      pg_version: "12.15"
+      pg_version: "13.16"
     steps:
       - opus10/test
 
   test_pg_max:
     executor:
       name: opus10/python
-      pg_version: "16.0"
+      pg_version: "16.4"
     steps:
       - opus10/test
 
@@ -69,16 +68,6 @@ jobs:
       - run: make dependencies
       - run: make type-check || true
 
-  check_changelog:
-    executor: opus10/python
-    steps:
-      - checkout
-      - restore_cache:
-          key: v4-{{ checksum "poetry.lock" }} 
-      - run: make dependencies
-      - run: git tidy-log origin/main..
-      - run: make tidy-lint
-
   deploy:
     executor: opus10/python
     steps:
@@ -94,14 +83,22 @@ workflows:
   version: 2
   on_commit:
     jobs:
-      - test_pg_min
-      - test_pg_max
-      - lint
-      - type_check
-      - check_changelog:
+      - test_pg_min:
           filters:
-            branches:
-              ignore: main
+            tags:
+              only: /.*/
+      - test_pg_max:
+          filters:
+            tags:
+              only: /.*/
+      - lint:
+          filters:
+            tags:
+              only: /.*/
+      - type_check:
+          filters:
+            tags:
+              only: /.*/
       - deploy:
           context: python-library
           requires:
@@ -111,4 +108,6 @@ workflows:
             - type_check
           filters:
             branches:
-              only: main
+              ignore: /.*/
+            tags:
+              only: /.*/

CHANGELOG.md

@@ -1,40 +1,46 @@
 # Changelog
 
+## 1.3.4 (2024-08-24)
+
+#### Changes
+
+  - Updated docs styling and testing dependencies by [@wesleykendall](https://github.com/wesleykendall) in [#18](https://github.com/Opus10/django-strict-fields/pull/18).
+
 ## 1.3.3 (2024-04-23)
 
-### Trivial
+#### Trivial
 
   - Update with latest Python template. [Wesley Kendall, e3ce25b]
 
 ## 1.3.2 (2024-04-18)
 
-### Trivial
+#### Trivial
 
   - Upgrade with latest Python template. [Wesley Kendall, 5de5e50]
 
 ## 1.3.1 (2024-04-06)
 
-### Trivial
+#### Trivial
 
   - Fix ReadTheDocs builds. [Wesley Kendall, 2769787]
 
 ## 1.3.0 (2023-11-26)
 
-### Feature
+#### Feature
 
   - Django 5.0 compatibility [Wesley Kendall, 313db19]
 
     Support and test against Django 5 with psycopg2 and psycopg3.
 
 ## 1.2.1 (2023-10-09)
 
-### Trivial
+#### Trivial
 
   - Added Opus10 branding to docs [Wesley Kendall, e04bb67]
 
 ## 1.2.0 (2023-10-08)
 
-### Feature
+#### Feature
 
   - Add Python 3.12 support and use Mkdocs for documentation [Wesley Kendall, cd84ed5]
 
@@ -44,51 +50,51 @@
 
 ## 1.1.0 (2023-06-09)
 
-### Feature
+#### Feature
 
   - Added Python 3.11, Django 4.2, and Psycopg 3 support [Wesley Kendall, b2926d4]
 
     Adds Python 3.11, Django 4.2, and Psycopg 3 support along with tests for multiple Postgres versions. Drops support for Django 2.2.
 
 ## 1.0.6 (2022-08-26)
 
-### Trivial
+#### Trivial
 
   - Test against Django 4.1 and other CI improvements [Wes Kendall, abc5f20]
 
 ## 1.0.5 (2022-08-24)
 
-### Trivial
+#### Trivial
 
   - Fix ReadTheDocs builds [Wes Kendall, 1a965ac]
 
 ## 1.0.4 (2022-08-20)
 
-### Trivial
+#### Trivial
 
   - Updated with latest Django template [Wes Kendall, fda30c9]
 
 ## 1.0.3 (2022-08-20)
 
-### Trivial
+#### Trivial
 
   - Fix release note rendering and code formatting changes [Wes Kendall, 592722b]
 
 ## 1.0.2 (2022-07-31)
 
-### Trivial
+#### Trivial
 
   - Updated with latest Django template, fixing doc builds [Wes Kendall, f429cca]
 
 ## 1.0.1 (2021-06-06)
 
-### Trivial
+#### Trivial
 
   - Updated with latest Django template [Wes Kendall, 859b6d7]
 
 ## 1.0.0 (2020-07-01)
 
-### Api-Break
+#### Api-Break
 
   - Initial release of django-strict-fields [Tómas Árni Jónasson, 46948b6]
 

CONTRIBUTING.md

@@ -32,24 +32,6 @@ If your code fails the linter checks, fix common errors with:
 
     make lint-fix
 
-## Committing
-
-This project uses [git-tidy](https://github.com/Opus10/git-tidy) to produce structured commits with git trailers. Information from commit messages is used to generate release notes and bump the version properly.
-
-To do a structured commit with `git-tidy`, do:
-
-    make tidy-commit
-
-All commits in a pull request must be tidy commits that encapsulate a change. Ideally entire features or bug fixes are encapsulated in a single commit. Squash all of your commits into a tidy commit with:
-
-    make tidy-squash
-
-To check if your commits pass linting, do:
-
-    make tidy-lint
-
-Note, the above command lints every commit since branching from main. You can also run `make shell` and run `git tidy` commands inside the docker environment to do other flavors of `git tidy` commands.
-
 ## Documentation
 
 [Mkdocs Material](https://squidfunk.github.io/mkdocs-material/) documentation can be built with:
@@ -62,10 +44,4 @@ A shortcut for serving them is:
 
 ## Releases and Versioning
 
-Anything that is merged into the main branch will be automatically deployed to PyPI. Documentation will be published to a ReadTheDocs at `https://django-strict-fields.readthedocs.io/`.
-
-The following files will be generated and should *not* be edited by a user:
-
-- `CHANGELOG.md` - Contains an automatically-generated change log for each release.
-
-This project uses [Semantic Versioning](http://semver.org) by analyzing `Type:` trailers on git commit messages (trailers are added when using `git tidy-commit`). In order to bump the minor version, use "feature" or "bug" as the type. In order to bump the major version, use "api-break". The patch version will be updated automatically if none of these tags are present.
+The version number and release notes are manually updated by the maintainer during the release process. Do not edit these.