Merge pull request #2 from emqx/250430-fix-versions-and-urls

chore: update links and add version management

Author: savonarola

.bumpversion.cfg

@@ -0,0 +1,27 @@
+[bumpversion]
+current_version = 1.0.0
+commit = True
+commit_args = --no-verify
+tag = True
+tag_name = v{new_version}
+message = Version bumpup: {current_version} → {new_version}
+
+[bumpversion:file:rebar.config]
+search = emqx_offline_message_plugin, "{current_version}"
+replace = emqx_offline_message_plugin, "{new_version}"
+
+[bumpversion:file:src/emqx_offline_message_plugin.app.src]
+search = vsn, "{current_version}"
+replace = vsn, "{new_version}"
+
+[bumpversion:file (download link):README.md]
+search = download/v{current_version}/
+replace = download/v{new_version}/
+
+[bumpversion:file (plugin name-vsn):README.md]
+search = emqx_offline_message_plugin-{current_version}
+replace = emqx_offline_message_plugin-{new_version}
+
+[bumpversion:file:include/emqx_omp.hrl]
+search = PLUGIN_RELEASE_VERSION, "{current_version}"
+replace = PLUGIN_RELEASE_VERSION, "{new_version}"

Makefile

@@ -89,7 +89,8 @@ up:
 down:
 	docker compose down --volumes
 
-
-
-
+# bump-version-patch/minor/major
+.PHONY: bump-version-%
+bump-version-%:
+	./scripts/bumpversion.sh $*
 

README.md

@@ -4,12 +4,14 @@
 
 Download the plugin:
 
+<!-- Do not update plugin version manually, use make bump-version-patch/minor/major instead -->
 ```bash
-wget https://github.com/savonarola/emqx-offline-message-plugin/releases/download/v0.0.7/emqx_offline_message_plugin-1.0.0.tar.gz
+wget https://github.com/emqx/emqx-offline-message-plugin/releases/download/v1.0.0/emqx_offline_message_plugin-1.0.0.tar.gz
 ```
 
 Install the plugin:
 
+<!-- Do not update plugin version manually, use make bump-version-patch/minor/major instead -->
 ```bash
 curl -u key:secret -X POST http://localhost:18083/api/v5/plugins/install \
 -H "Content-Type: multipart/form-data" \

include/emqx_omp.hrl

@@ -5,6 +5,7 @@
 -define(METRICS_WORKER, emqx_omp_metrics_worker).
 -define(PLUGIN_NAME, emqx_offline_message_plugin).
 
+%% Do not update version manually, use make bump-version-patch/minor/major instead
 -define(PLUGIN_RELEASE_VERSION, "1.0.0").
 
 -define(PLUGIN_NAME_VSN, <<"emqx_offline_message_plugin-", ?PLUGIN_RELEASE_VERSION>>).

rebar.config

@@ -37,9 +37,13 @@
 
 %% this is the release version, different from app vsn in .app file
 {relx, [
-    {release, {emqx_offline_message_plugin, "1.0.0"}, [
-        emqx_offline_message_plugin
-    ]},
+    {release,
+        %% Do not update version manually, use make bump-version-patch/minor/major instead
+        {emqx_offline_message_plugin, "1.0.0"},
+        [
+            emqx_offline_message_plugin
+        ]
+    },
     {dev_mode, false},
     {include_erts, false},
     {include_src, false}

scripts/bumpversion.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -uo pipefail
+
+if [ $# -ne 1 ]; then
+    echo "Usage: $0 <patch|minor|major>"
+    exit 1
+fi
+
+level="$1"
+
+if [ "$level" != "patch" ] && [ "$level" != "minor" ] && [ "$level" != "major" ]; then
+    echo "Usage: $0 <patch|minor|major>"
+    exit 1
+fi
+
+bump2version_present=$(command -v bump2version || echo "false")
+if [ "$bump2version_present" = "false" ]; then
+    echo "Please install bump2version first: pip install bump2version"
+    exit 1
+fi
+
+exec bump2version "$level"
+

src/emqx_offline_message_plugin.app.src

@@ -1,6 +1,7 @@
 {application, emqx_offline_message_plugin, [
     {description, "EMQX Offline Message Plugin"},
-    {vsn, "0.1.0"},
+    %% Do not update version manually, use make bump-version-patch/minor/major instead
+    {vsn, "1.0.0"},
     {modules, []},
     {registered, [emqx_omp_sup]},
     {applications, [kernel, stdlib]},