Skip to content

chore: Add workflow for docs verification #WPB-19997 #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: Add workflow for docs verification #WPB-19997 #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4da4d59
chore: Add workflow for docs verification #WPB-19997
alexandreferris Sep 10, 2025
3400027
chore: Add workflow for docs verification #WPB-19997
alexandreferris Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/docs-verification.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Docs

on:
workflow_dispatch:
pull_request:
paths:
- 'docs/**'

jobs:
docs-verification:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v5
- uses: actions/setup-java@v5
with:
distribution: 'zulu'
java-version: '17'

- name: Setup Nix
uses: cachix/install-nix-action@v16

- name: Clone wire-docs and build
run: |
git clone --branch main https://github.com/wireapp/wire-docs.git wire-docs
cd wire-docs

CURRENT_REPO_URL="https://github.com/${GITHUB_REPOSITORY}.git"

if [ -n "$GITHUB_HEAD_REF" ]; then
CURRENT_BRANCH="$GITHUB_HEAD_REF"
else
CURRENT_BRANCH="${GITHUB_REF#refs/heads/}"
fi

sed -i "s|url = https://github.com/wireapp/wire-apps-jvm-sdk.git|url = ${CURRENT_REPO_URL}|g" .gitmodules
sed -i "s|branch = main|branch = ${CURRENT_BRANCH}|g" .gitmodules

cat .gitmodules
make build
Comment on lines +22 to +39
Copy link

@coderabbitai coderabbitai bot Sep 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Submodule isn’t initialized/updated after editing .gitmodules.

Without sync/update, make build may use a stale/missing submodule.

Append after the .gitmodules edits:

           sed -i "s|url = https://github.com/wireapp/wire-apps-jvm-sdk.git|url = ${CURRENT_REPO_URL}|g" .gitmodules
           sed -i "s|branch = main|branch = ${CURRENT_BRANCH}|g" .gitmodules
           
           cat .gitmodules
+          git submodule sync --recursive
+          git submodule update --init --recursive --checkout --remote
           make build
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Clone wire-docs and build
run: |
git clone --branch main https://github.com/wireapp/wire-docs.git wire-docs
cd wire-docs
CURRENT_REPO_URL="https://github.com/${GITHUB_REPOSITORY}.git"
if [ -n "$GITHUB_HEAD_REF" ]; then
CURRENT_BRANCH="$GITHUB_HEAD_REF"
else
CURRENT_BRANCH="${GITHUB_REF#refs/heads/}"
fi
sed -i "s|url = https://github.com/wireapp/wire-apps-jvm-sdk.git|url = ${CURRENT_REPO_URL}|g" .gitmodules
sed -i "s|branch = main|branch = ${CURRENT_BRANCH}|g" .gitmodules
cat .gitmodules
make build
- name: Clone wire-docs and build
run: |
git clone --branch main https://github.com/wireapp/wire-docs.git wire-docs
cd wire-docs
CURRENT_REPO_URL="https://github.com/${GITHUB_REPOSITORY}.git"
if [ -n "$GITHUB_HEAD_REF" ]; then
CURRENT_BRANCH="$GITHUB_HEAD_REF"
else
CURRENT_BRANCH="${GITHUB_REF#refs/heads/}"
fi
sed -i "s|url = https://github.com/wireapp/wire-apps-jvm-sdk.git|url = ${CURRENT_REPO_URL}|g" .gitmodules
sed -i "s|branch = main|branch = ${CURRENT_BRANCH}|g" .gitmodules
cat .gitmodules
git submodule sync --recursive
git submodule update --init --recursive --checkout --remote
make build
🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 26-26: trailing spaces

(trailing-spaces)

[error] 28-28: trailing spaces

(trailing-spaces)

[error] 34-34: trailing spaces

(trailing-spaces)

[error] 37-37: trailing spaces

(trailing-spaces)

🤖 Prompt for AI Agents 
In .github/workflows/docs-verification.yml around lines 22 to 39, after the two
sed edits to .gitmodules and before running make build, ensure the repo
submodules are synced and initialized/updated; append commands to run a
recursive git submodule sync and then git submodule update --init --recursive
(optionally with --remote) so the modified .gitmodules takes effect and the
build uses the updated submodule content.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexandreferris Isn't CodeRabbit actually right here?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spoonman01 This logic for updating the submodule is inside the build logic:
https://github.com/wireapp/wire-docs/blob/main/build/build_versions.sh#L74
we can find the logs for submodule processing in the run here:
https://github.com/wireapp/wire-apps-jvm-sdk/actions/runs/17618708717/job/50061657173#step:5:341

2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ When a page needs to be moved because it's related to code changes:
```
cd src/integrations/
rm creating-an-app.md
ln -s ../../../wire-apps-jvm-sdk/docs/src/creating-an-app.md creating-an-app.md
ln -s ../../wire-apps-jvm-sdk/docs/src/creating-an-app.md creating-an-app.md
```
3. Test with `make run` before creating a PR

Expand Down
2 changes: 1 addition & 1 deletion docs/src/permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# App Permissions
# Permissions

Permissions define what your app is allowed to do inside the platform.

Expand Down