Skip to content

Commit cff210f

Browse files
authoredMar 26, 2025
Update bundle publish steps (#312)
Fix instructions for updating bundle version and creating the tag.
1 parent f4aa8ed commit cff210f

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed
 

Diff for: ‎README.adoc

+14-11
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,12 @@ To use this UI with Antora, add the following configuration to your playbook fil
2020
----
2121
ui:
2222
bundle:
23-
url: https://s3-eu-west-1.amazonaws.com/static-content.neo4j.com/build/ui-bundle-{latest-version}.zip
23+
url: https://static-content.neo4j.com/build/ui-bundle-latest.zip
2424
----
2525

26-
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`.
2726

2827
== Installation
2928

30-
In order to build the UI:
31-
3229
[source,sh]
3330
npm i
3431

@@ -57,17 +54,23 @@ PORT=3000 npm start
5754
====
5855

5956

60-
== Publish a new version
57+
== Publish a new UI bundle version
6158

62-
The release process is automated and relies on GitHub Actions.
59+
The release process is automated and uses GitHub Actions.
6360
See the `.github/workflows/release.yml` file for details.
6461

65-
The release will be performed when a tag is pushed, the procedure is:
62+
The release is performed when a tag is pushed.
6663

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:
6866
+
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:
7071

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`
72+
- `\https://static-content.neo4j.com/build/ui-bundle-vx.y.z.zip`
73+
- `\https://static-content.neo4j.com/build/ui-bundle-latest.zip`
7274

73-
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

Comments
 (0)