Merge pull request #6 from ESGF/release/0.3.1

Release/0.3.1

Author: djspstfc

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "poetry" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+### General:
+
+* [ ] Have you followed the guidelines in our Contributing document?
+* [ ] Have all checks, quality assurance steps and tests passed?
+
+### Quality checks:
+
+* [ ] Have you updates the **CHANGELOG.rst** file?
+* [ ] Have you updated the `version` and `author` attributes (as appropriate) in the **pyproject.toml** file?
+
+### Community standards:
+
+* [ ] Have you followed [Semantic Versioning](https://semver.org)?
+* [ ] Have you updated the **docstrings** and / or **documentation** files to reflect your change?
+
+### What is the purpose of this change?
+
+The purpose of this change is to...
+
+### What does the change consist of?
+
+This change consists of...

CHANGELOG.rst

@@ -0,0 +1,62 @@
+Changelog
+=========
+
+All notable changes to this package are recorded in this document.
+
+This format is based on `Keep a ChangeLog <https://keepachangelog.com/>`_ and this project
+adheres to `Semantic Versioning <https://semver.org>`_.
+
+[Unreleased]
+------------
+
+Added
+^^^^^
+
+Changed
+^^^^^^^
+
+Removed
+^^^^^^^
+
+Fixed
+^^^^^
+
+[0.3.1] <https://github.com/ESGF/esgf-playground-utils/releases/tag/0.3.1>`_ - 2024-08-13
+------------------------------------------------------------------------------------------
+
+Added
+^^^^^
+
+- Community documentation
+- Pre-commit hooks for quality
+- Documentation published to GitHub Pages
+
+Changed
+^^^^^^^
+
+- :py:attr:`esgf_playground_utils.models.kafka.UpdatePayload.item_id` added to enable canonical id of resource
+  to be changed.
+
+Removed
+^^^^^^^
+
+Fixed
+^^^^^
+
+`[0.3.0] <https://github.com/ESGF/esgf-playground-utils/releases/tag/0.3.0>`_ - 2024-07-22
+------------------------------------------------------------------------------------------
+
+Initial working release.
+
+Added
+^^^^^
+
+Changed
+^^^^^^^
+
+Removed
+^^^^^^^
+
+Fixed
+^^^^^
+

CONTRIBUTING.md

@@ -9,7 +9,7 @@ feel free to create one.
 
 ## Development environment
 
-Begin by collecting the repo from github.
+Begin by collecting the repo from [GitHub](https://github.com/ESGF/esgf-playground-utils).
 
 To contribute, you should be using `poetry` as your python package
 manager, see <https://python-poetry.org> for installation instructions.
@@ -54,6 +54,7 @@ You can also (and are encouraged to) run the `pre-commit hooks` manually
 as often as you like with:
 
 ``` shell
+foo@bar:~$ git stage -A
 foo@bar:~$ poetry run pre-commit run -a
 ```
 

docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

docs/index.rst

@@ -16,4 +16,5 @@ ESGF Playground Utils documentation
    contributing
    code_of_conduct
    license
+   changelog
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "esgf-playground-utils"
-version = "0.3.1-alpha.2"
+version = "0.3.1"
 description = "Common library and models for the ESGF-Playground"
 authors = [
     "David Poulter <david.poulter@stfc.ac.uk>",