Prepare 1.0 release candidate

CHANGELOG.rst

@@ -2,9 +2,31 @@
 Release notes
 =============
 
-dev (unreleased)
-================
+1.0.0-rc.0 (2024-12-12)
+=======================
 
-In its current phase, we're iterating quickly and do not publish versioned releases yet.
+We proudly announce the first release candidate of GPP-Publicatiebank!
 
-On Docker Hub, the ``latest`` tag follows the ``main`` branch from Github.
+The 1.0 version of this component is ready for production. It provides the minimal
+functionalities to be able to comply with the WOO legislation in your organization.
+
+Features
+--------
+
+* Admin panel for technical and functional administrators
+
+    - Manage metadata for publications, such as organizations, information categories
+      and themes.
+    - Manage publications and documents, where a publication acts as a container for one
+      or more documents.
+    - Manage API clients and user acocunts.
+    - View (audit) logs for actions performed on/related to publications.
+    - Configure connections to external services, like a Documents API and OpenID
+      Connect provider.
+
+* JSON API for full publication life-cycle management.
+* Automatically populated metadata from national value lists sourced from overheid.nl.
+* OpenID Connect or local user account with MFA authentication options for the admin
+  panel.
+* Extensive documentation, from API specification to (admin) user manual.
+* Helm charts to deploy on Kubernetes cluster(s).

README.EN.rst

@@ -2,7 +2,7 @@
 Public documents registration
 =============================
 
-:Version: 0.1.0
+:Version: 1.0.0-rc.0
 :Source: https://github.com/GPP-Woo/GPP-publicatiebank
 :Keywords: WOO, Public Documents, NL, Open Data
 
@@ -48,9 +48,9 @@ Version         Release date    API specification
 ==============  ==============  =============================
 latest          n/a             `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/main/src/woo_publications/api/openapi.yaml>`_,
                                 `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/main/src/woo_publications/api/openapi.yaml>`_,
-                                (`verschillen <https://github.com/GPP-Woo/GPP-publicatiebank/compare/0.1.0..main#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
-0.1.0           YYYY-MM-DD      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/0.1.0/src/woo_publications/api/openapi.yaml>`_,
-                                `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/0.1.0/src/woo_publications/api/openapi.yaml>`_
+                                (`verschillen <https://github.com/GPP-Woo/GPP-publicatiebank/compare/1.0.0-rc.0..main>`_)
+1.0.0           2024-12-12      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/1.0.0-rc.0/src/woo_publications/api/openapi.yaml>`_,
+                                `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/1.0.0-rc.0/src/woo_publications/api/openapi.yaml>`_
 ==============  ==============  =============================
 
 See: `All versions and changes <https://github.com/GPP-Woo/GPP-publicatiebank/blob/main/CHANGELOG.rst>`_

README.rst

@@ -2,7 +2,7 @@
 Openbare Documenten Registratie
 ===============================
 
-:Version: 0.1.0
+:Version: 1.0.0-rc.0
 :Source: https://github.com/GPP-Woo/GPP-publicatiebank
 :Keywords: WOO, Openbare Documenten, NL, Open Data
 
@@ -47,9 +47,9 @@ Versie          Release datum   API specificatie
 ==============  ==============  =============================
 latest          n/a             `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/main/src/woo_publications/api/openapi.yaml>`_,
                                 `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/main/src/woo_publications/api/openapi.yaml>`_,
-                                (`verschillen <https://github.com/GPP-Woo/GPP-publicatiebank/compare/0.1.0..main#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
-0.1.0           YYYY-MM-DD      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/0.1.0/src/woo_publications/api/openapi.yaml>`_,
-                                `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/0.1.0/src/woo_publications/api/openapi.yaml>`_
+                                (`verschillen <https://github.com/GPP-Woo/GPP-publicatiebank/compare/1.0.0-rc.0..main>`_)
+1.0.0           2024-12-12      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/1.0.0-rc.0/src/woo_publications/api/openapi.yaml>`_,
+                                `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/1.0.0-rc.0/src/woo_publications/api/openapi.yaml>`_
 ==============  ==============  =============================
 
 Zie: `Alle versies en wijzigingen <https://github.com/GPP-Woo/GPP-publicatiebank/blob/main/CHANGELOG.rst>`_

package.json

@@ -1,7 +1,7 @@
 {
     "name": "woo-publications",
     "private": true,
-    "version": "0.1.0",
+    "version": "1.0.0-rc.0",
     "description": "woo_publications project",
     "main": "src/static/woo_publications/js/woo_publications.js",
     "scripts": {

pyproject.toml

@@ -3,3 +3,64 @@ requires-python = "3.12"
 
 [tool.uv.pip]
 emit-index-url = false
+
+[tool.bumpversion]
+current_version = "1.0.0-rc.0"
+parse = """(?x)
+    (?P<major>0|[1-9]\\d*)\\.
+    (?P<minor>0|[1-9]\\d*)\\.
+    (?P<patch>0|[1-9]\\d*)
+    (?:
+        -                             # dash separator for pre-release section
+        (?P<pre_l>[a-zA-Z-]+)\\.      # pre-release label
+        (?P<pre_n>0|[1-9]\\d*)        # pre-release version number
+    )?                                # pre-release section is optional
+"""
+serialize = [
+    "{major}.{minor}.{patch}-{pre_l}.{pre_n}",
+    "{major}.{minor}.{patch}",
+]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = false
+sign_tags = false
+tag_name = "{new_version}"
+tag_message = ":arrow_up: Bump version to {new_version} and update changelog"
+allow_dirty = false
+commit = false
+message = ":arrow_up: Bump version to {new_version} and update changelog"
+commit_args = ""
+setup_hooks = []
+pre_commit_hooks = [
+    "npm i",  # ensure that package-lock.json is updated
+]
+post_commit_hooks = []
+
+[tool.bumpversion.parts.pre_l]
+values = ["dev", "beta", "rc", "final"]
+optional_value = "final"
+
+[[tool.bumpversion.files]]
+filename = "src/woo_publications/__init__.py"
+
+[[tool.bumpversion.files]]
+filename = "src/woo_publications/conf/locale/nl/LC_MESSAGES/django.po"
+
+[[tool.bumpversion.files]]
+filename = "README.rst"
+search = ":Version: {current_version}"
+replace = ":Version: {new_version}"
+
+[[tool.bumpversion.files]]
+filename = "README.EN.rst"
+search = ":Version: {current_version}"
+replace = ":Version: {new_version}"
+
+[[tool.bumpversion.files]]
+filename = "package.json"
+search = "    \"version\": \"{current_version}\""
+replace = "    \"version\": \"{new_version}\""
+

requirements/dev.in

@@ -2,7 +2,7 @@
 -r ci.txt
 
 # Helpers
-bump2version
+bump-my-version
 gitpython
 
 # Debug tooling

requirements/dev.txt

@@ -10,6 +10,8 @@ amqp==5.2.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   kombu
+annotated-types==0.7.0
+    # via pydantic
 ape-pie==0.2.0
     # via
     #   -c requirements/ci.txt
@@ -65,7 +67,9 @@ boltons==24.0.0
     #   -r requirements/ci.txt
     #   face
     #   glom
-bump2version==1.0.1
+bracex==2.5.post1
+    # via wcmatch
+bump-my-version==0.28.1
     # via -r requirements/dev.in
 cbor2==5.6.4
     # via
@@ -101,10 +105,12 @@ click==8.1.7
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   black
+    #   bump-my-version
     #   celery
     #   click-didyoumean
     #   click-plugins
     #   click-repl
+    #   rich-click
 click-didyoumean==0.3.1
     # via
     #   -c requirements/ci.txt
@@ -566,6 +572,8 @@ markdown==3.7
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-markup
+markdown-it-py==3.0.0
+    # via rich
 markupsafe==2.1.5
     # via
     #   -c requirements/ci.txt
@@ -581,6 +589,8 @@ mccabe==0.7.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   flake8
+mdurl==0.1.2
+    # via markdown-it-py
 mozilla-django-oidc==4.0.1
     # via
     #   -c requirements/ci.txt
@@ -663,6 +673,7 @@ prompt-toolkit==3.0.47
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   click-repl
+    #   questionary
 psycopg2==2.9.9
     # via
     #   -c requirements/ci.txt
@@ -678,6 +689,14 @@ pycparser==2.22
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   cffi
+pydantic==2.10.3
+    # via
+    #   bump-my-version
+    #   pydantic-settings
+pydantic-core==2.27.1
+    # via pydantic
+pydantic-settings==2.6.1
+    # via bump-my-version
 pyflakes==3.2.0
     # via
     #   -c requirements/ci.txt
@@ -688,6 +707,7 @@ pygments==2.18.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-markup
+    #   rich
     #   sphinx
     #   sphinx-tabs
 pyjwt==2.9.0
@@ -739,6 +759,7 @@ python-dotenv==1.0.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
+    #   pydantic-settings
 python-ipware==3.0.0
     # via
     #   -c requirements/ci.txt
@@ -764,6 +785,8 @@ qrcode==7.4.2
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-two-factor-auth
+questionary==1.10.0
+    # via bump-my-version
 redis==5.0.8
     # via
     #   -c requirements/ci.txt
@@ -799,6 +822,12 @@ requests-mock==1.12.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+rich==13.9.4
+    # via
+    #   bump-my-version
+    #   rich-click
+rich-click==1.8.5
+    # via bump-my-version
 rpds-py==0.20.0
     # via
     #   -c requirements/ci.txt
@@ -904,6 +933,8 @@ textile==4.0.2
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-markup
+tomlkit==0.13.2
+    # via bump-my-version
 tornado==6.4.2
     # via
     #   -c requirements/ci.txt
@@ -914,7 +945,10 @@ typing-extensions==4.12.2
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
+    #   pydantic
+    #   pydantic-core
     #   qrcode
+    #   rich-click
     #   zgw-consumers
 tzdata==2024.1
     # via
@@ -956,6 +990,8 @@ waitress==3.0.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   webtest
+wcmatch==10.0
+    # via bump-my-version
 wcwidth==0.2.13
     # via
     #   -c requirements/ci.txt

src/woo_publications/__init__.py

@@ -1,6 +1,6 @@
 # from .celery import app as celery_app
 
 # __all__ = ("celery_app",)
-__version__ = "0.1.0"
+__version__ = "1.0.0-rc.0"
 __author__ = "Maykin"
 __homepage__ = "https://github.com/GPP-Woo/GPP-publicatiebank"