From 7049c1723de69c33da8a16bf7fe94fc5149cd4a0 Mon Sep 17 00:00:00 2001 From: Swann Date: Tue, 2 Mar 2021 09:58:06 +0100 Subject: [PATCH 1/9] feat: initial CI job for building the documentation for gitlab page --- .gitlab-ci.yml | 3 +++ .gitlab/ci/doc.gitlab-ci.yml | 11 +++++++++++ 2 files changed, 14 insertions(+) create mode 100644 .gitlab/ci/doc.gitlab-ci.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 36eedb7..36d3def 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,10 +1,13 @@ stages: - test - build + - doc - deploy + include: - local: .gitlab/ci/test.gitlab-ci.yml - local: .gitlab/ci/build.gitlab-ci.yml - local: .gitlab/ci/deploy.gitlab-ci.yml + - local: .gitlab/ci/doc.gitlab-ci.yml diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml new file mode 100644 index 0000000..fb08c61 --- /dev/null +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -0,0 +1,11 @@ +pages: + stage: doc + image: python:3.7-alpine + script: + - pip install -U sphinx sphinx_rtd_theme + - sphinx-build -b html ./docs public + artifacts: + paths: + - public + + From 55ca8a7b84dd920575206c6269feceb5fdfbc30a Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:03:19 +0000 Subject: [PATCH 2/9] Update .gitlab/ci/doc.gitlab-ci.yml --- .gitlab/ci/doc.gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index fb08c61..7411d45 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -1,4 +1,5 @@ pages: + needs: ["build"] stage: doc image: python:3.7-alpine script: From 238a34d0236f6a6daa03677479dc2646f593af86 Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:05:21 +0000 Subject: [PATCH 3/9] feat: needs test to success --- .gitlab/ci/build.gitlab-ci.yml | 1 + .gitlab/ci/deploy.gitlab-ci.yml | 1 + .gitlab/ci/doc.gitlab-ci.yml | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.gitlab/ci/build.gitlab-ci.yml b/.gitlab/ci/build.gitlab-ci.yml index 9b75485..13cac6d 100644 --- a/.gitlab/ci/build.gitlab-ci.yml +++ b/.gitlab/ci/build.gitlab-ci.yml @@ -1,5 +1,6 @@ build: stage: build + needs: ["test"] image: debian:stable-slim script: - rm -rf tests .git .gitignore script diff --git a/.gitlab/ci/deploy.gitlab-ci.yml b/.gitlab/ci/deploy.gitlab-ci.yml index cb63ba9..298dabe 100644 --- a/.gitlab/ci/deploy.gitlab-ci.yml +++ b/.gitlab/ci/deploy.gitlab-ci.yml @@ -1,5 +1,6 @@ deploy: stage: deploy + needs: ["test"] image: slumber/docker-python variables: DOCKER_DRIVER: overlay2 diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index 7411d45..2ea7123 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -1,5 +1,5 @@ pages: - needs: ["build"] + needs: ["test"] stage: doc image: python:3.7-alpine script: From d2215b662c72c219201786e49b59a398b5c771cd Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:06:32 +0000 Subject: [PATCH 4/9] feat: update jobs dependencies --- .gitlab/ci/deploy.gitlab-ci.yml | 2 +- .gitlab/ci/doc.gitlab-ci.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab/ci/deploy.gitlab-ci.yml b/.gitlab/ci/deploy.gitlab-ci.yml index 298dabe..1fe0489 100644 --- a/.gitlab/ci/deploy.gitlab-ci.yml +++ b/.gitlab/ci/deploy.gitlab-ci.yml @@ -1,6 +1,6 @@ deploy: stage: deploy - needs: ["test"] + needs: ["build"] image: slumber/docker-python variables: DOCKER_DRIVER: overlay2 diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index 2ea7123..0f21148 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -1,5 +1,5 @@ pages: - needs: ["test"] + needs: ["build","deploy"] stage: doc image: python:3.7-alpine script: From 113ab81cbf543e118002226eb4d6a8fcbad99619 Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:07:50 +0000 Subject: [PATCH 5/9] Update .gitlab/ci/doc.gitlab-ci.yml --- .gitlab/ci/doc.gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index 0f21148..07b279f 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -1,5 +1,5 @@ pages: - needs: ["build","deploy"] + needs: ["deploy"] stage: doc image: python:3.7-alpine script: From 5e29c6fe2694a2b0ee3e51a7406867e449c94280 Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:08:39 +0000 Subject: [PATCH 6/9] Update .gitlab/ci/doc.gitlab-ci.yml --- .gitlab/ci/doc.gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index 07b279f..5490874 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -1,6 +1,6 @@ pages: - needs: ["deploy"] stage: doc + needs: ["deploy"] image: python:3.7-alpine script: - pip install -U sphinx sphinx_rtd_theme From 73b763d85f5260c603275175ac87acedc9c98d18 Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Tue, 2 Mar 2021 09:09:50 +0000 Subject: [PATCH 7/9] fix: job ordering error --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 36d3def..c7c6485 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,8 +1,8 @@ stages: - test - build - - doc - deploy + - doc From 4726a90a4acc5eefd6e97096f56ebf26f92a1b7a Mon Sep 17 00:00:00 2001 From: Swann Date: Tue, 2 Mar 2021 10:16:59 +0100 Subject: [PATCH 8/9] doc: reflect doc hosting changes to the Readme.md --- README.md | 66 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 38ab491..d2c8991 100644 --- a/README.md +++ b/README.md @@ -19,44 +19,46 @@ This tool aims to allow multiple users to work on the same scene over the networ ## Usage -See the [documentation](https://multi-user.readthedocs.io/en/latest/) for details. +See the [documentation](https://slumber.gitlab.io/multi-user/index.html) for details. ## Troubleshooting -See the [troubleshooting guide](https://multi-user.readthedocs.io/en/latest/getting_started/troubleshooting.html) for tips on the most common issues. +See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html) for tips on the most common issues. ## Current development status Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones. -| Name | Status | Comment | -| ----------- | :----: | :--------------------------------------------------------------------------: | -| action | ✔️ | | -| armature | ❗ | Not stable | -| camera | ✔️ | | -| collection | ✔️ | | -| curve | ❗ | Nurbs not supported | -| gpencil | ✔️ | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) | -| image | ✔️ | | -| mesh | ✔️ | | -| material | ✔️ | | -| node_groups | ❗ | Material only | -| metaball | ✔️ | | -| object | ✔️ | | -| textures | ❗ | Supported for modifiers only | -| texts | ✔️ | | -| scene | ✔️ | | -| world | ✔️ | | -| lightprobes | ✔️ | | -| compositing | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/46) | -| texts | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/81) | -| nla | ❌ | | -| volumes | ✔️ | | -| particles | ❌ | [On-going](https://gitlab.com/slumber/multi-user/-/issues/24) | -| speakers | ❗ | [Partial](https://gitlab.com/slumber/multi-user/-/issues/65) | -| vse | ❗ | Mask and Clip not supported yet | -| physics | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/45) | -| libraries | ❗ | Partial | +| Name | Status | Comment | +| -------------- | :----: | :--------------------------------------------------------------------------: | +| action | ✔️ | | +| armature | ❗ | Not stable | +| camera | ✔️ | | +| collection | ✔️ | | +| curve | ❗ | Nurbs surfaces not supported | +| gpencil | ✔️ | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) | +| image | ✔️ | | +| mesh | ✔️ | | +| material | ✔️ | | +| node_groups | ❗ | Material only | +| geometry nodes | ✔️ | | +| metaball | ✔️ | | +| object | ✔️ | | +| textures | ❗ | Supported for modifiers/materials only | +| texts | ✔️ | | +| scene | ✔️ | | +| world | ✔️ | | +| lightprobes | ✔️ | | +| compositing | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/46) | +| texts | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/81) | +| nla | ❌ | | +| volumes | ✔️ | | +| particles | ❌ | [On-going](https://gitlab.com/slumber/multi-user/-/issues/24) | +| speakers | ❗ | [Partial](https://gitlab.com/slumber/multi-user/-/issues/65) | +| vse | ❗ | Mask and Clip not supported yet | +| physics | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/45) | +| libraries | ❗ | Partial | + ### Performance issues @@ -68,13 +70,13 @@ I'm working on it. | Dependencies | Version | Needed | | ------------ | :-----: | -----: | -| Replication | latest | yes | +| Replication | latest | yes | ## Contributing -See [contributing section](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html) of the documentation. +See [contributing section](https://slumber.gitlab.io/multi-user/ways_to_contribute.html) of the documentation. Feel free to [join the discord server](https://discord.gg/aBPvGws) to chat, seek help and contribute. From 3d9c78c2f997af3eac1d6c0b669d2f075ebf7562 Mon Sep 17 00:00:00 2001 From: Swann Date: Tue, 2 Mar 2021 10:18:11 +0100 Subject: [PATCH 9/9] doc: only build for master/develop --- .gitlab/ci/doc.gitlab-ci.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitlab/ci/doc.gitlab-ci.yml b/.gitlab/ci/doc.gitlab-ci.yml index 5490874..a6ae794 100644 --- a/.gitlab/ci/doc.gitlab-ci.yml +++ b/.gitlab/ci/doc.gitlab-ci.yml @@ -8,5 +8,9 @@ pages: artifacts: paths: - public + only: + refs: + - master + - develop