You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NOTE: If you want to use the latest version (unreleased) you can use the following URL: `\https://s3-eu-west-1.amazonaws.com/static-content.neo4j.com/build/ui-bundle.zip`.
27
26
28
27
== Installation
29
28
30
-
In order to build the UI:
31
-
32
29
[source,sh]
33
30
npm i
34
31
@@ -57,17 +54,23 @@ PORT=3000 npm start
57
54
====
58
55
59
56
60
-
== Publish a new version
57
+
== Publish a new UI bundle version
61
58
62
-
The release process is automated and relies on GitHub Actions.
59
+
The release process is automated and uses GitHub Actions.
63
60
See the `.github/workflows/release.yml` file for details.
64
61
65
-
The release will be performed when a tag is pushed, the procedure is:
62
+
The release is performed when a tag is pushed.
66
63
67
-
. Tag and push to `master` (don't forget the `v` prefix and replace `x.y.z` with an actual version):
64
+
. Use `npm version patch` or `npm version minor` to increase the version in the `package.json` file and create a tag for the new verrsion.
65
+
. Push the tag upstream:
68
66
+
69
-
$ git tag vx.y.z && git push origin master --tags
67
+
$ git push--tags upstream master
68
+
69
+
The UI bundle is published to S3.
70
+
It is available from two URLs:
70
71
71
-
The UI bundle will be published to S3 and available shortly at: `\https://s3-eu-west-1.amazonaws.com/static-content.neo4j.com/build/ui-bundle-vx.y.z.zip`
The UI bundle and docs pages are shipped/built separately. You don't have to rebuild docs projects for them to take the updated UI bundle, but you do need to run the TC build located at `documentation / UI / Publish UI` for the latest tag of the UI bundle to be deployed.
75
+
When the tag is pushed, a TC build is triggered, which generates and publishes the latest `.css`, `.js` and other assets.
76
+
If the changes to the bundle include updates to any of the templates in _src/layouts_ or _src/partials_, each docset needs to be rebuilt with the new bundle and republished for the changes to take effect.
0 commit comments