Skip to content

Commit

Permalink
prepared Ditto JS client 3.0.1 release
Browse files Browse the repository at this point in the history
* added RELEASE.md docs describing how to release the Ditto JS client

Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
  • Loading branch information
thjaeckle committed Nov 17, 2022
1 parent 591ac59 commit 4003fdb
Show file tree
Hide file tree
Showing 10 changed files with 1,766 additions and 1,117 deletions.
36 changes: 36 additions & 0 deletions javascript/RELEASE.md
@@ -0,0 +1,36 @@
# Releasing Ditto JavaScript Client

Perform the following steps

## Update the [CHANGELOG.md](CHANGELOG.md)

The JavaScript client has a separate changelog, update the included fixes/changes in there before the release.

## Build Ditto JavaScript client release

* Go to javascript folder and execute `npm run update-version`
* Choose/set the correct version, which is also used by Ditto.
* You might run into an error if the current branch is not allowed: `lerna ERR! ENOTALLOWED Branch '<branch-name>' is restricted from versioning due to allowBranch config.`
* You can use an extra parameter in this case: `npm run update-version -- --allow-branch <branch-name>`
* Verify the versions are correctly set in
* javascript/lerna.json
* javascript/lib/api/package.json
* javascript/lib/api/package-lock.json
* javascript/lib/dom/package.json
* javascript/lib/dom/package-lock.json
* javascript/lib/node/package.json
* javascript/lib/node/package-lock.json
* Update the versions manually in
* javascript/package.json
* javascript/package-lock.json
* Create a commit with all updated versions and give it a tag: js_<client-version>
* this might be the same tag as for the Ditto Java Client release or a separate one, e.g. js_1.1.2, js_2.1.1, etc.
* `git tag -a js_1.0.0 -m "tag Ditto JavaScript 1.0.0 release"`
* `git push eclipse js_1.0.0`

## Release the Client

* Retrieve the npm token of the Eclipse Ditto npm user.
* Use the release job on Eclipse Ditto jenkins:
* https://ci.eclipse.org/ditto/job/ditto-client-javascript-release/
* it will read the version that should be published from package.json
2 changes: 1 addition & 1 deletion javascript/lerna.json
Expand Up @@ -16,5 +16,5 @@
]
}
},
"version": "3.0.0"
"version": "3.0.1"
}
4 changes: 2 additions & 2 deletions javascript/lib/api/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion javascript/lib/api/package.json
@@ -1,6 +1,6 @@
{
"name": "@eclipse-ditto/ditto-javascript-client-api",
"version": "3.0.0",
"version": "3.0.1",
"description": "API interfaces for implementing TypeScript clients for Eclipse Ditto",
"author": "Eclipse Ditto committers <ditto-dev@eclipse.org>",
"repository": "https://github.com/eclipse/ditto-clients",
Expand Down
4 changes: 2 additions & 2 deletions javascript/lib/dom/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion javascript/lib/dom/package.json
@@ -1,6 +1,6 @@
{
"name": "@eclipse-ditto/ditto-javascript-client-dom",
"version": "3.0.0",
"version": "3.0.1",
"description": "DOM implementation of Eclipse Ditto JavaScript API to be used in browsers.",
"author": "Eclipse Ditto committers <ditto-dev@eclipse.org>",
"repository": "https://github.com/eclipse/ditto-clients",
Expand Down
4 changes: 2 additions & 2 deletions javascript/lib/node/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion javascript/lib/node/package.json
@@ -1,6 +1,6 @@
{
"name": "@eclipse-ditto/ditto-javascript-client-node",
"version": "3.0.0",
"version": "3.0.1",
"description": "Node.js(r) implementation of Eclipse Ditto JavaScript API.",
"author": "Eclipse Ditto committers <ditto-dev@eclipse.org>",
"repository": "https://github.com/eclipse/ditto-clients",
Expand Down

0 comments on commit 4003fdb

Please sign in to comment.