chore(release): prepare version 0.5.0

Also improve the documentation of the release procedure.
maxGraph · Dec 7, 2023 · 9463e1e · 9463e1e
1 parent e1e7c19
commit 9463e1e
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # `maxGraph` Change Log
 
+## 0.5.0
+
+Release date: `2023-12-07`
+
+This release contains new features, bug fixes and documentation improvements.
+
+**Breaking Changes**
+- the UMD bundle is no more provided in the npm package.
+
+For more details, see the [0.5.0 Changelog](https://github.com/maxGraph/maxGraph/releases/tag/v0.5.0) on the GitHub release page.
+
 ## 0.4.1
 
 Release date: `2023-10-30`

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -2,7 +2,7 @@
   "name": "@maxgraph/core",
   "license": "Apache-2.0",
   "private": false,
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.",
   "keywords": [
     "browser",

diff --git a/packages/core/src/Client.ts b/packages/core/src/Client.ts
@@ -20,7 +20,7 @@ class Client {
   /**
    * Contains the current version of the maxGraph library.
    */
-  static VERSION = '0.4.1';
+  static VERSION = '0.5.0';
 
   /**
    * Base path for all URLs in the core without trailing slash.

diff --git a/packages/website/docs/development/release.md b/packages/website/docs/development/release.md
@@ -26,6 +26,7 @@ released. Rename it if necessary.
 
 Changes in the source code
 - Update the version in `packages/core/package.json` and the `VERSION` constant in the `packages/core/src/Client.ts` file.
+- Update the `package-lock.json` file by running npm install at the root of the repository. It should only change the version of `@maxgraph/core`.
 - Update the `CHANGELOG` file to list the major changes included in the new version. Be generic and add a
 link to the future GitHub release that will contain detailed release notes, as shown below.
 ```markdown
@@ -35,6 +36,10 @@ the GitHub release page.
 - Make a single commit that includes the changes described above
   - use the following template for the commit message: `chore(release): prepare version 0.2.0`
   - push the changes
+    - The default branch is protected by a GitHub ruleset and prevent to push directly to the branch
+    - Update the ruleset and add a [bypass permission](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-ruleset) for your account
+    - Run the git push command
+    - Update the ruleset to remove the bypass permission 
 
 Create a git tag, prefixing the version with a `v`. For example, if the version is 0.2.0, run