From 941bcf67176f4d94e97612f34912467eb3b74714 Mon Sep 17 00:00:00 2001 From: Simon Date: Tue, 17 Sep 2024 12:26:46 +0200 Subject: [PATCH] Deploy documentation for Nexus 1.10 release (#5142) * Deploy documentation for Nexus 1.10 release --------- Co-authored-by: Simon Dumas --- .gitmodules | 4 ++++ README.md | 14 +++++++++++++- build.sh | 2 +- versions/snapshot | 2 +- versions/v1.10.x | 1 + versions/versions.md | 11 ++++++++--- 6 files changed, 28 insertions(+), 6 deletions(-) create mode 160000 versions/v1.10.x diff --git a/.gitmodules b/.gitmodules index 495cedd502..e8217d01b2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -18,3 +18,7 @@ path = versions/v1.9.x url = git@github.com:BlueBrain/nexus.git branch = v1.9.x +[submodule "versions/v1.10.x"] + path = versions/v1.10.x + url = git@github.com:BlueBrain/nexus.git + branch = v1.10.x diff --git a/README.md b/README.md index 2a46596505..e9e8f1ff22 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,16 @@ $ git submodule update --remote --merge $ ./build.sh ``` -The product page and the documentation should be built and extracted under the target directory. \ No newline at end of file +The product page and the documentation should be built and extracted under the target directory. + +To release a new version: + +* Run the following git command to add another git submodule: + +``` + git submodule add -b $branch -f --name "versions/$branch" git@github.com:BlueBrain/nexus.git versions/$branch/ +``` + +* Update the versions/versions.md file and create the new current / push the previous in the older releases +* Update the current branch in the build.sh file +* Example: https://github.com/BlueBrain/nexus/pull/5142 diff --git a/build.sh b/build.sh index 2e4274cd1c..a8d70e10c1 100755 --- a/build.sh +++ b/build.sh @@ -14,7 +14,7 @@ chmod +x /usr/local/bin/docker-compose cp -R ./product-page/src/site/* ./target # Build every version of docs -current_version=v1.9.x +current_version=v1.10.x for i in $(ls -d versions/*/); do diff --git a/versions/snapshot b/versions/snapshot index 823d072f73..479d9d06fb 160000 --- a/versions/snapshot +++ b/versions/snapshot @@ -1 +1 @@ -Subproject commit 823d072f735c6831b7c2a7136de22a3c7a395b33 +Subproject commit 479d9d06fb614b46deb7b546783cd8cfcfb17403 diff --git a/versions/v1.10.x b/versions/v1.10.x new file mode 160000 index 0000000000..ae142c20e7 --- /dev/null +++ b/versions/v1.10.x @@ -0,0 +1 @@ +Subproject commit ae142c20e7ed289ca0764933c9848f58944373b5 diff --git a/versions/versions.md b/versions/versions.md index d1d1d0e705..e49ebcd1e7 100644 --- a/versions/versions.md +++ b/versions/versions.md @@ -1,9 +1,9 @@ # Versions -## Current (v1.9.x) +## Current (v1.10.x) - @link:[Documentation](https://bluebrainnexus.io/docs/) -- @link:[Github](https://github.com/BlueBrain/nexus/tree/v1.9.x){ open=new } -- @link:[Release notes](https://bluebrainnexus.io/docs/releases/v1.9-release-notes.html) +- @link:[Github](https://github.com/BlueBrain/nexus/tree/v1.10.x){ open=new } +- @link:[Release notes](https://bluebrainnexus.io/docs/releases/v1.10-release-notes.html) ## Snapshot - @link:[Documentation](https://bluebrainnexus.io/snapshot/docs/) @@ -11,6 +11,11 @@ ## Previous releases +## v1.8.x +- @link:[Documentation](https://bluebrainnexus.io/v1.9.x/docs/) +- @link:[Github](https://github.com/BlueBrain/nexus/tree/v1.9.x){ open=new } +- @link:[Release notes](https://bluebrainnexus.io/docs/releases/v1.9-release-notes.html) + ## v1.8.x - @link:[Documentation](https://bluebrainnexus.io/v1.8.x/docs/) - @link:[Github](https://github.com/BlueBrain/nexus/tree/v1.8.x){ open=new }