From e0cf68912c704b4a7cf8ea5725e6a16afc1cb14f Mon Sep 17 00:00:00 2001 From: alexandreferris Date: Tue, 9 Sep 2025 16:40:08 +0200 Subject: [PATCH 1/3] add documentation for Apps SDK --- .gitmodules | 5 +++++ build/build_versions.sh | 4 +++- mkdocs.yml | 4 ++++ src/README.md | 1 + src/integrations/README.md | 1 + src/integrations/creating-an-app.md | 1 + src/integrations/images/create-app.png | 1 + src/integrations/permissions.md | 1 + wire-apps-jvm-sdk | 1 + 9 files changed, 18 insertions(+), 1 deletion(-) create mode 120000 src/integrations/README.md create mode 120000 src/integrations/creating-an-app.md create mode 120000 src/integrations/images/create-app.png create mode 120000 src/integrations/permissions.md create mode 160000 wire-apps-jvm-sdk diff --git a/.gitmodules b/.gitmodules index fa09393..0f42ee7 100644 --- a/.gitmodules +++ b/.gitmodules @@ -2,3 +2,8 @@ path = wire-server url = https://github.com/wireapp/wire-server.git branch = develop + +[submodule "wire-apps-jvm-sdk"] + path = wire-apps-jvm-sdk + url = https://github.com/wireapp/wire-apps-jvm-sdk.git + branch = main diff --git a/build/build_versions.sh b/build/build_versions.sh index 47b7dc8..137115e 100644 --- a/build/build_versions.sh +++ b/build/build_versions.sh @@ -71,7 +71,8 @@ git checkout ${CURRENT_TAG} # pull the submodule git submodule update --init --depth 1 wire-server - +git submodule update --init --depth 1 wire-apps-jvm-sdk + # Check if tag exists in mike if [ -n "${existing_tags[$CURRENT_TAG]}" ]; then existing_commit="${existing_tags[$CURRENT_TAG]}" @@ -91,6 +92,7 @@ else # deinit the submodule to avoid issues with the next iteration git submodule deinit -f wire-server +git submodule deinit -f wire-apps-jvm-sdk # Set the default tag and create an alias to $CURRENT_TAG $mike set-default $CURRENT_TAG diff --git a/mkdocs.yml b/mkdocs.yml index 1008615..193f1d4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -98,6 +98,10 @@ nav: - Connection: developer/reference/user/connection.md - User Registration: developer/reference/user/registration.md - User Rich info: developer/reference/user/rich-info.md + - Apps SDK: + - Understanding Apps: integrations/README.md + - Creating An App: integrations/creating-an-app.md + - Permissions: integrations/permissions.md - Security Responses: - Overview: security-responses/README.md - "2023-01-19 - Security Advisory: HTML Injection in wire.com": security-responses/2023-01-19_html_injection.md diff --git a/src/README.md b/src/README.md index fba6077..ecc8869 100644 --- a/src/README.md +++ b/src/README.md @@ -23,6 +23,7 @@ Release notes of `wire-server` can be found [here](https://github.com/wireapp/wi * [Administration](how-to/administrate/README.md) * [Reference](understand/README.md) * [Developers Notes](developer/README.md) +* [Apps SDK](integrations/README.md) * [Security responses](security-responses/README.md) * [Release Notes](changelog/README.md) diff --git a/src/integrations/README.md b/src/integrations/README.md new file mode 120000 index 0000000..921a586 --- /dev/null +++ b/src/integrations/README.md @@ -0,0 +1 @@ +../../wire-apps-jvm-sdk/docs/src/README.md \ No newline at end of file diff --git a/src/integrations/creating-an-app.md b/src/integrations/creating-an-app.md new file mode 120000 index 0000000..80b2f0d --- /dev/null +++ b/src/integrations/creating-an-app.md @@ -0,0 +1 @@ +../../wire-apps-jvm-sdk/docs/src/creating-an-app.md \ No newline at end of file diff --git a/src/integrations/images/create-app.png b/src/integrations/images/create-app.png new file mode 120000 index 0000000..391d9c9 --- /dev/null +++ b/src/integrations/images/create-app.png @@ -0,0 +1 @@ +../../../wire-apps-jvm-sdk/docs/src/images/create-app.png \ No newline at end of file diff --git a/src/integrations/permissions.md b/src/integrations/permissions.md new file mode 120000 index 0000000..4f63269 --- /dev/null +++ b/src/integrations/permissions.md @@ -0,0 +1 @@ +../../wire-apps-jvm-sdk/docs/src/permissions.md \ No newline at end of file diff --git a/wire-apps-jvm-sdk b/wire-apps-jvm-sdk new file mode 160000 index 0000000..9def627 --- /dev/null +++ b/wire-apps-jvm-sdk @@ -0,0 +1 @@ +Subproject commit 9def627a22627de74825868d7b1282a2f04cbb1a From 284e9c29564840253e516aacf1067fb9c2d52f12 Mon Sep 17 00:00:00 2001 From: mohitrajain <20745774+mohitrajain@users.noreply.github.com> Date: Wed, 10 Sep 2025 17:04:15 +0200 Subject: [PATCH 2/3] enable verbose logs --- build/build_versions.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/build_versions.sh b/build/build_versions.sh index 137115e..95b2a39 100644 --- a/build/build_versions.sh +++ b/build/build_versions.sh @@ -1,6 +1,6 @@ #!/bin/bash -set -e +set -ex mike="pipenv run mike" CURRENT=$(git branch --show-current) From 7c4de643890980640de5d3e96370b3418cc08e76 Mon Sep 17 00:00:00 2001 From: mohitrajain <20745774+mohitrajain@users.noreply.github.com> Date: Wed, 10 Sep 2025 17:20:47 +0200 Subject: [PATCH 3/3] wpb-20149: fix prepare logic to rsync submodule wire-apps-jvm-sdk properly --- build/build_versions.sh | 2 +- build/prepare.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build/build_versions.sh b/build/build_versions.sh index 95b2a39..137115e 100644 --- a/build/build_versions.sh +++ b/build/build_versions.sh @@ -1,6 +1,6 @@ #!/bin/bash -set -ex +set -e mike="pipenv run mike" CURRENT=$(git branch --show-current) diff --git a/build/prepare.sh b/build/prepare.sh index 70dbf2f..b9966f4 100644 --- a/build/prepare.sh +++ b/build/prepare.sh @@ -51,4 +51,4 @@ else fi echo "Syncing all the other files changes from ${ORIGINAL_DIR}/ to ${TEMP_DIR}, to work on uncommited changes, if any" -rsync -a --exclude='/.git' --exclude="/wire-server" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/" +rsync -a --exclude='/.git' --exclude="/wire-server" --exclude="/wire-apps-jvm-sdk" --exclude='wire-docs*.tar.gz' --exclude=".tmpdir" "${ORIGINAL_DIR}/" "$TEMP_DIR/"