From 7544da2da3aaa9488da03059fb76c24637ad485a Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Fri, 22 Dec 2023 08:11:34 +0100 Subject: [PATCH] chore(release): prepare version 0.6.0 Also improve the release procedure. --- CHANGELOG.md | 6 ++++- package-lock.json | 2 +- packages/core/package.json | 2 +- packages/core/src/Client.ts | 4 ++-- packages/website/docs/development/release.md | 24 ++++++++++++-------- 5 files changed, 23 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ac0c12ea..dc0b3a340 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # `maxGraph` Change Log -# UNRELEASED +## 0.6.0 + +Release date: `2023-12-22` **Breaking Changes** - Codecs supplied by `maxGraph` are no longer registered by default. They **MUST** be registered before performing an `encode` or `decode`. @@ -11,6 +13,8 @@ You can use one of the following functions to register codecs: To serialize the `maxGraph` model, you can use the `ModelXmlSerializer` class, which registers codecs under the hood. +For more details, see the [0.6.0 Changelog](https://github.com/maxGraph/maxGraph/releases/tag/v0.6.0) on the GitHub release page. + ## 0.5.0 Release date: `2023-12-07` diff --git a/package-lock.json b/package-lock.json index 501edb18b..12dc229b0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24967,7 +24967,7 @@ }, "packages/core": { "name": "@maxgraph/core", - "version": "0.5.0", + "version": "0.6.0", "license": "Apache-2.0", "devDependencies": { "jest": "^29.3.1", diff --git a/packages/core/package.json b/packages/core/package.json index 8aff66514..30676b341 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.5.0", + "version": "0.6.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 541ad931a..e0c0e46cd 100644 --- a/packages/core/src/Client.ts +++ b/packages/core/src/Client.ts @@ -18,9 +18,9 @@ limitations under the License. class Client { /** - * Contains the current version of the maxGraph library. + * The version of the `maxGraph` library. */ - static VERSION = '0.5.0'; + static VERSION = '0.6.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 c74837418..977f7f7a4 100644 --- a/packages/website/docs/development/release.md +++ b/packages/website/docs/development/release.md @@ -29,25 +29,29 @@ Changes in the source code - 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 +``` For more details, see the [0.1.0 Changelog](https://github.com/maxGraph/maxGraph/releases/tag/v0.1.0) on 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 + - 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 that prevents direct pushing 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: ``` git fetch --tags git tag v0.2.0 -git push origin v0.2.0 ``` +- Push the tag + - As for the default branch, tags are protected by a GitHub ruleset that prevents direct pushing tags. + - 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 tag push, for example `git push origin v0.2.0` + - Update the ruleset to remove the bypass permission. ## Publish the npm package