Merge pull request #49 from maykinmedia/feature/prepare-release-template

 📝 [maykinmedia/open-api-framework#107] Add prepare release template

Author: stevenbal

.bumpversion.cfg

@@ -1,15 +1,15 @@
 [bumpversion]
 commit = False
 tag = False
-current_version = 0.1.0
+current_version = 0.0.4
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<pre>[a-z]+)\.(?P<build>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}-{pre}.{build}
 	{major}.{minor}.{patch}
 
 [bumpversion:part:pre]
 first_value = alpha
-values = 
+values =
 	alpha
 	beta
 	rc
@@ -29,5 +29,5 @@ replace = :Version: {new_version}
 # replace = softwareVersion: {new_version}
 
 [bumpversion:file:package.json]
-search = "version": "{current_version}",
-replace = "version": "{new_version}",
+search = "version": "{current_version}"
+replace = "version": "{new_version}"

.github/ISSUE_TEMPLATE/prepare-release.md

@@ -3,16 +3,18 @@ name: Prepare release
 about: Checklist for new releases
 title: Prepare release x.y.z
 labels: ''
+type: Release
+projects: ["maykinmedia/15"]
 ---
 
 - [ ] Resolve release blockers
   - [ ] ...
+- [ ] Upgrade `open-api-framework` to latest version
+- [ ] Check security tab and upgrade packages to fix vulnerabilities
 - [ ] Check translations
-  - [ ] Backend
-  - [ ] Frontend
-- [ ] Bump API version number
+- [ ] Bump API version number (if applicable)
   - [ ] Version bump
   - [ ] Regenerate API spec
   - [ ] Update READMEs with release dates + links
-- [ ] Bump version number (including package-lock.json)
+- [ ] Bump version number with `bin/bump-my-version.sh bump <major|minor|patch>`
 - [ ] Update changelog

CHANGELOG.rst

@@ -1,5 +1,5 @@
-0.0.x (TBD)
------------
+0.0.4 (18-02-2025)
+------------------
 
 **Project maintenance**
 
@@ -10,6 +10,11 @@
 * [#29] Added Read the Docs documentation
 * [#29] Added CHANGELOG file
 
+**New features**
+
+* Added multi-language support for PRODUCTTYPEN.
+* Added CONTENTELEMENTEN & CONTENTLABELS.
+
 
 0.0.3 (04-02-2025)
 ------------------

README.EN.rst

@@ -2,7 +2,7 @@
 open_producten
 ==================
 
-:Version: 0.0.1
+:Version: 0.0.4
 :Source: https://github.com/maykinmedia/open-producten
 :Keywords: ``products``
 

README.rst

@@ -2,7 +2,7 @@
 open_producten
 ==================
 
-:Version: 0.0.1
+:Version: 0.0.4
 :Source: https://github.com/maykinmedia/open-producten
 :Keywords: ``producten``
 

bin/bump-my-version.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+#
+# Script to bump the version. Arguments are forwarded to bump-my-version.
+#
+# Usage:
+#
+#   ./bin/bumpversion.sh bump minor|patch|pre|build
+#
+
+set -eu -o pipefail
+
+toplevel=$(git rev-parse --show-toplevel)
+cd $toplevel
+
+# Ensure a virtualenv is active.
+if [ -z $VIRTUAL_ENV ]; then
+    echo "VIRTUAL_ENV envvar is not set, you must activate your virtualenv before running this script."
+    exit 1
+fi
+
+# Forward all arguments to bump-my-version binary
+bump-my-version "$@"
+
+# Run npm install to update the package-lock.json version number
+npm i

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "open_producten",
-    "version": "0.0.1",
+    "version": "0.0.4",
     "description": "open-producten project",
     "main": "src/static/open-producten/js/open-producten.js",
     "directories": {

package.json

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

requirements/dev.in

@@ -10,6 +10,10 @@ amqp==5.3.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   kombu
+annotated-types==0.7.0
+    # via pydantic
+anyio==4.8.0
+    # via httpx
 ape-pie==0.2.0
     # via
     #   -c requirements/ci.txt
@@ -72,7 +76,9 @@ boltons==24.1.0
     #   -r requirements/ci.txt
     #   face
     #   glom
-bump2version==1.0.1
+bracex==2.5.post1
+    # via wcmatch
+bump-my-version==0.32.1
     # via -r requirements/dev.in
 cbor2==5.6.5
     # via
@@ -92,6 +98,8 @@ certifi==2024.8.30
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   elastic-apm
+    #   httpcore
+    #   httpx
     #   requests
     #   sentry-sdk
 cffi==1.17.1
@@ -109,10 +117,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
@@ -503,6 +513,12 @@ glom==24.11.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
+h11==0.14.0
+    # via httpcore
+httpcore==1.0.7
+    # via httpx
+httpx==0.28.1
+    # via bump-my-version
 humanize==4.11.0
     # via
     #   -c requirements/ci.txt
@@ -512,6 +528,8 @@ idna==3.10
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   anyio
+    #   httpx
     #   requests
 imagesize==1.4.1
     # via
@@ -588,6 +606,8 @@ markdown==3.3.6
     #   django-markdownx
     #   django-markup
     #   sphinx-markdown-tables
+markdown-it-py==3.0.0
+    # via rich
 markupsafe==3.0.2
     # via
     #   -c requirements/ci.txt
@@ -604,6 +624,8 @@ mccabe==0.7.0
     #   -r requirements/ci.txt
     #   flake8
     #   pylint
+mdurl==0.1.2
+    # via markdown-it-py
 mozilla-django-oidc==4.0.1
     # via
     #   -c requirements/ci.txt
@@ -687,6 +709,7 @@ prompt-toolkit==3.0.48
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   click-repl
+    #   questionary
 psycopg2==2.9.10
     # via
     #   -c requirements/ci.txt
@@ -702,6 +725,14 @@ pycparser==2.22
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   cffi
+pydantic==2.10.6
+    # via
+    #   bump-my-version
+    #   pydantic-settings
+pydantic-core==2.27.2
+    # via pydantic
+pydantic-settings==2.7.1
+    # via bump-my-version
 pyflakes==3.2.0
     # via
     #   -c requirements/ci.txt
@@ -712,6 +743,7 @@ pygments==2.18.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-markup
+    #   rich
     #   sphinx
     #   sphinx-tabs
 pyjwt==2.10.1
@@ -773,6 +805,7 @@ python-dotenv==1.0.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
+    #   pydantic-settings
 python-stdnum==1.20
     # via
     #   -c requirements/ci.txt
@@ -797,6 +830,8 @@ qrcode==7.4.2
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-two-factor-auth
+questionary==2.1.0
+    # via bump-my-version
 recommonmark==0.7.1
     # via
     #   -c requirements/ci.txt
@@ -835,6 +870,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.21.0
     # via
     #   -c requirements/ci.txt
@@ -860,6 +901,8 @@ smartypants==2.0.1
     #   django-markup
 smmap==5.0.1
     # via gitdb
+sniffio==1.3.1
+    # via anyio
 snowballstemmer==2.2.0
     # via
     #   -c requirements/ci.txt
@@ -938,6 +981,7 @@ tomlkit==0.13.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   bump-my-version
     #   pylint
 tornado==6.4.2
     # via
@@ -948,9 +992,13 @@ typing-extensions==4.12.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   anyio
     #   faker
     #   mozilla-django-oidc-db
+    #   pydantic
+    #   pydantic-core
     #   qrcode
+    #   rich-click
     #   zgw-consumers
 tzdata==2024.2
     # via
@@ -990,6 +1038,8 @@ waitress==3.0.2
     #   -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

requirements/dev.txt

@@ -1,6 +1,6 @@
 from .celery import app as celery_app
 
 __all__ = ("celery_app",)
-__version__ = "0.1.0"
+__version__ = "0.0.4"
 __author__ = "Maykin"
 __homepage__ = "https://github.com/maykinmedia/open-producten"