Skip to content

Commit

Permalink
Deploy documentation for Nexus 1.10 release (#5142)
Browse files Browse the repository at this point in the history
* Deploy documentation for Nexus 1.10 release

---------

Co-authored-by: Simon Dumas <[email protected]>
  • Loading branch information
imsdu and Simon Dumas authored Sep 17, 2024
1 parent 0b1e0eb commit 941bcf6
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@
path = versions/v1.9.x
url = [email protected]:BlueBrain/nexus.git
branch = v1.9.x
[submodule "versions/v1.10.x"]
path = versions/v1.10.x
url = [email protected]:BlueBrain/nexus.git
branch = v1.10.x
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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" [email protected]: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
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion versions/snapshot
Submodule snapshot updated 23 files
+5 −5 build.sbt
+0 −11 ...torage/src/main/scala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/CopyResult.scala
+11 −0 ...src/main/scala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/S3OperationResult.scala
+1 −1 ...src/main/scala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/S3StorageSaveFile.scala
+4 −4 ...ain/scala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/client/S3StorageClient.scala
+5 −4 ...a/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/client/S3StorageClientDisabled.scala
+21 −19 ...scala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/client/S3StorageClientImpl.scala
+23 −7 ...cala/ch/epfl/bluebrain/nexus/delta/plugins/storage/storages/operations/s3/client/S3StorageClientSuite.scala
+1 −1 delta/testkit/src/main/scala/ch/epfl/bluebrain/nexus/testkit/elasticsearch/ElasticSearchContainer.scala
+1 −0 docs/ignore-paths.txt
+1 −1 docs/src/main/paradox/docs/delta/api/assets/version.json
+1 −1 docs/src/main/paradox/docs/delta/api/resources-api.md
+1 −1 docs/src/main/paradox/docs/faq.md
+2 −2 docs/src/main/paradox/docs/fusion/architecture.md
+1 −1 docs/src/main/paradox/docs/getting-started/running-nexus/docker/docker-compose.yaml
+2 −2 docs/src/main/paradox/docs/getting-started/running-nexus/index.md
+24 −3 docs/src/main/paradox/docs/releases/index.md
+15 −7 docs/src/main/paradox/docs/releases/v1.10-release-notes.md
+1 −1 project/build.properties
+3 −3 ship/src/main/scala/ch/epfl/bluebrain/nexus/ship/files/FileCopier.scala
+6 −5 tests/docker/config/construct-query.sparql
+1 −1 tests/docker/docker-compose.yml
+28 −5 tests/src/test/resources/kg/search/data/trace.json
1 change: 1 addition & 0 deletions versions/v1.10.x
Submodule v1.10.x added at ae142c
11 changes: 8 additions & 3 deletions versions/versions.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# 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/)
- @link:[Github](https://github.com/BlueBrain/nexus){ open=new }

## 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 }
Expand Down

0 comments on commit 941bcf6

Please sign in to comment.