chore(release): prepare version 0.5.0

Also improve the documentation of the release procedure.
development
Thomas Bouffard 2023-12-07 16:50:39 +01:00
parent e1e7c19e3d
commit 9463e1e21e
5 changed files with 19 additions and 3 deletions

View File

@ -1,5 +1,16 @@
# `maxGraph` Change Log # `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 ## 0.4.1
Release date: `2023-10-30` Release date: `2023-10-30`

2
package-lock.json generated
View File

@ -24967,7 +24967,7 @@
}, },
"packages/core": { "packages/core": {
"name": "@maxgraph/core", "name": "@maxgraph/core",
"version": "0.4.1", "version": "0.5.0",
"license": "Apache-2.0", "license": "Apache-2.0",
"devDependencies": { "devDependencies": {
"jest": "^29.3.1", "jest": "^29.3.1",

View File

@ -2,7 +2,7 @@
"name": "@maxgraph/core", "name": "@maxgraph/core",
"license": "Apache-2.0", "license": "Apache-2.0",
"private": false, "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.", "description": "maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.",
"keywords": [ "keywords": [
"browser", "browser",

View File

@ -20,7 +20,7 @@ class Client {
/** /**
* Contains the current version of the maxGraph library. * 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. * Base path for all URLs in the core without trailing slash.

View File

@ -26,6 +26,7 @@ released. Rename it if necessary.
Changes in the source code 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 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 - 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. link to the future GitHub release that will contain detailed release notes, as shown below.
```markdown ```markdown
@ -35,6 +36,10 @@ the GitHub release page.
- Make a single commit that includes the changes described above - 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` - use the following template for the commit message: `chore(release): prepare version 0.2.0`
- push the changes - 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 Create a git tag, prefixing the version with a `v`. For example, if the version is 0.2.0, run