.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+- [ ] I have read the [section on commits and pull requests](https://github.com/NaturalHistoryMuseum/ckanext-contact/blob/main/CONTRIBUTING.md#commits-and-pull-requests) in `CONTRIBUTING.md`
+
+
+Describe your changes, tagging relevant issues where possible.

.github/SUPPORT.md

@@ -1,15 +1,16 @@
 # Support
 
 ## Documentation
+- [ckanext-contact documentation](https://ckanext-contact.readthedocs.io)
 - [Our API documentation](https://naturalhistorymuseum.github.io/dataportal-docs)
 - [Official CKAN documentation](http://docs.ckan.org/en/latest)
 
 ## Issues
+- [Issues for ckanext-contact](https://github.com/NaturalHistoryMuseum/ckanext-contact/issues)
 - [The NHM on Github](https://github.com/NaturalHistoryMuseum)
 - [General issue tracker](https://github.com/NaturalHistoryMuseum/data-portal-issues/issues)
-- [Our CKAN extensions](https://github.com/search?q=topic%3Ackan+org%3ANaturalHistoryMuseum&type=repositories) (for more specific issues)
+- [Our CKAN extensions](https://github.com/search?q=topic:ckan+org:NaturalHistoryMuseum&type=repositories) (for more specific issues)
 
 ## Contact Us
 - [Gitter](https://gitter.im/nhm-data-portal/lobby)
 - [Email _data@nhm.ac.uk_](mailto:data@nhm.ac.uk)
-- [Twitter](https://twitter.com/nhm_data)

.github/workflows/bump.yml

@@ -7,12 +7,12 @@ on:
 
 jobs:
   bump-version:
-    if: "!startsWith(github.event.head_commit.message, 'bump:')"
+    name: Bump version and create changelog
     runs-on: ubuntu-latest
-    name: "Bump version and create changelog"
+    if: "!startsWith(github.event.head_commit.message, 'bump:')"
     steps:
-      - name: Check out
-        uses: actions/checkout@v3
+      - name: Checkout source code
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
           fetch-depth: 0

.github/workflows/pull-requests.yml

@@ -0,0 +1,27 @@
+name: Validate pull requests
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+jobs:
+  validate-commits:
+    name: Validate commit messages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+      - name: Check commit message format
+        uses: webiny/action-conventional-commits@v1.3.0
+        with:
+          allowed-commit-types: 'feat,fix,refactor,perf,docs,style,test,build,ci,chore,new,patch,revert,ui,merge'
+  pre-commit:
+    name: Run pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1

.github/workflows/pypi-publish.yml

@@ -10,17 +10,16 @@ permissions:
 
 jobs:
   deploy:
+    name: Deploy package to PyPI
     runs-on: ubuntu-latest
     steps:
-      - name: Check out
-        uses: actions/checkout@v3
+      - name: Checkout source code
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v3
-        with:
-          python-version: '3.x'
+        uses: actions/setup-python@v5
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/sync.yml

@@ -0,0 +1,27 @@
+name: Sync branches
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  sync-branches:
+    name: Sync dev and patch branches to latest commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          fetch-depth: 0
+      - name: Sync dev branch
+        uses: connor-baer/action-sync-branch@main
+        with:
+          branch: dev
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+      - name: Sync patch branch
+        uses: connor-baer/action-sync-branch@main
+        with:
+          branch: patch
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

.github/workflows/main.yml → .github/workflows/tests.yml

@@ -3,19 +3,19 @@ name: Tests
 on:
   push:
   workflow_dispatch:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
 
 jobs:
   test:
+    name: Run tests
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
       - name: Build images
-        run: docker-compose build
-
+        run: docker compose build
       - name: Run tests
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-        run: docker-compose run -e COVERALLS_REPO_TOKEN ckan bash /opt/scripts/run-tests.sh -c ckanext.contact
+        run: docker compose run -e COVERALLS_REPO_TOKEN ckan bash /opt/scripts/run-tests.sh -c ckanext.contact

.pre-commit-config.yaml

@@ -1,27 +1,35 @@
+exclude: /(vendor|dist)/
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: name-tests-test
-        args: ["--pytest-test-first"]
+        args: ['--pytest-test-first']
         exclude: ^tests/helpers/
       - id: trailing-whitespace
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v2.37.0
+    rev: v3.30.0
     hooks:
       - id: commitizen
-        additional_dependencies: ["cz-nhm"]
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
+        additional_dependencies: ['cz-nhm']
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.1
     hooks:
-      - id: black
+      - id: ruff
+        args: [ '--fix', '--select', 'I', '--select', 'F401', '--fix-only' ]
+      - id: ruff-format
   - repo: https://github.com/PyCQA/docformatter
-    rev: v1.5.0
+    rev: eb1df34
     hooks:
       - id: docformatter
-        # these can't be pulled directly from the config atm, not sure why
-        args: ["-i", "--wrap-summaries=88", "--wrap-descriptions=88",
-               "--pre-summary-newline", "--make-summary-multi-line"]
+        args: [ '-i', '--config', './pyproject.toml' ]
+        additional_dependencies: ['tomli']
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        types_or: [ javascript, vue, less, sass, scss, css ]
+        args: [ '--single-quote' ]

.readthedocs.yaml

@@ -1,5 +1,10 @@
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 python:
   install:
     - requirements: docs/requirements.txt

CHANGELOG.md

@@ -1,5 +1,131 @@
 # Changelog
 
+## v2.4.3 (2024-11-04)
+
+### Docs
+
+- use variable logo based on colour scheme
+- fix tests badge tests workflow file was renamed
+
+## v2.4.2 (2024-11-04)
+
+### Docs
+
+- standardise returns field
+
+### Style
+
+- automatic reformat auto reformat with ruff/docformatter/prettier after config changes
+
+### Build System(s)
+
+- remove version from docker compose file version specifier is deprecated
+
+### CI System(s)
+
+- fix python setup action version
+- add merge to valid commit types
+- add docformatter args and dependency docformatter currently can't read from pyproject.toml without tomli
+- only apply auto-fixes in pre-commit F401 returns linting errors as well as auto-fixes, so this disables the errors and just applies the fixes
+- update tool config update pre-commit repo versions and switch black to ruff
+- add pull request validation workflow new workflow to check commit format and code style against pre-commit config
+- update workflow files standardise format, change name of tests file
+
+### Chores/Misc
+
+- add pull request template
+- update tool details in contributing guide
+
+## v2.4.1 (2024-08-20)
+
+## v2.4.0 (2024-01-15)
+
+### Feature
+
+- check provided email address with pyisemail
+
+### Fix
+
+- remove unnecessary markdown message in request field
+
+### Style
+
+- fix run-on sentence
+
+### Chores/Misc
+
+- add build section to read the docs config
+- add regex for version line in citation file
+- add citation.cff to list of files with version
+- add contributing guidelines
+- add code of conduct
+- add citation file
+- update support.md links
+
+## v2.3.1 (2023-07-17)
+
+### Docs
+
+- update logos
+
+## v2.3.0 (2023-04-11)
+
+### Feature
+
+- add a prefix to email subject when it's provided in the config
+- allow users to specify a subject line in their contact emails
+
+### Fix
+
+- expect no trailing space in the prefix from config
+
+### Refactor
+
+- move tests into unit subdir
+
+### Docs
+
+- add the new prefix option to the docs
+
+### Tests
+
+- fix a test
+- add additional tests for the ne subject changes
+
+### Build System(s)
+
+- fix postgres not loading when running tests in docker
+
+### Chores/Misc
+
+- add action to sync branches when commits are pushed to main
+
+## v2.2.0 (2023-04-03)
+
+### Feature
+
+- allow contact emails to be sent to multiple recipients
+
+## v2.1.6 (2023-02-20)
+
+### Docs
+
+- fix api docs generation script
+
+### Style
+
+- reformat with prettier
+
+### Chores/Misc
+
+- small fixes to align with other extensions
+
+## v2.1.5 (2023-01-31)
+
+### Docs
+
+- **readme**: change logo url from blob to raw
+
 ## v2.1.4 (2023-01-31)
 
 ### Docs