From 9463e1e21e82d8938c3611bde911555ea79e8ec0 Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:50:39 +0100 Subject: [PATCH] chore(release): prepare version 0.5.0 Also improve the documentation of the release procedure. --- CHANGELOG.md | 11 +++++++++++ package-lock.json | 2 +- packages/core/package.json | 2 +- packages/core/src/Client.ts | 2 +- packages/website/docs/development/release.md | 5 +++++ 5 files changed, 19 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 49f10ae52..2454ff85d 100644 --- 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 index 4e5388608..501edb18b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24967,7 +24967,7 @@ }, "packages/core": { "name": "@maxgraph/core", - "version": "0.4.1", + "version": "0.5.0", "license": "Apache-2.0", "devDependencies": { "jest": "^29.3.1", diff --git a/packages/core/package.json b/packages/core/package.json index 977fbd640..a6f8cc839 100644 --- 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 index 0356c299d..541ad931a 100644 --- 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 index 7d2931135..f249e1089 100644 --- 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