Merge branch 'dev' into release

Author: wielinde

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "deps"
+    labels:
+      - "dependencies"
+    groups:
+      npm-minor-patch:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"

.github/workflows/docker.yml

@@ -10,9 +10,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v5
       - name: Set SHORT_SHA
-        run: echo "SHORT_SHA=`echo ${GITHUB_SHA} | cut -c1-8`" >> $GITHUB_ENV
+        run: |
+          SHORT_SHA=`echo ${GITHUB_SHA} | cut -c1-8`
+          echo "SHORT_SHA=$SHORT_SHA" >> $GITHUB_ENV
+          echo "DOCKER_TAG=${{ github.ref_name }}-$SHORT_SHA" >> $GITHUB_ENV
 
+          # also include SHA in version string
+          sed -ri "s/\"version\": \"(.*)\"/\"version\": \"\1-$SHORT_SHA\"/g" package.json
       - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
@@ -25,12 +32,41 @@ jobs:
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
+          context: .
           push: true
           tags: |
             openproject/hocuspocus:latest
-            openproject/hocuspocus:${{ github.ref_name }}-${{ env.SHORT_SHA }}
+            openproject/hocuspocus:${{ env.DOCKER_TAG }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
       - name: Summarize build
         run: |
-          echo "Built \`openproject/hocuspocus:${{ github.ref_name }}-${{ env.SHORT_SHA }}\`" >> $GITHUB_STEP_SUMMARY
+
+      - name: Generate GHA token
+        id: generate-gha-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.DEPLOY_APP_ID }}
+          private-key: ${{ secrets.DEPLOY_APP_PRIVATE_KEY }}
+          owner: opf
+          repositories: saas-deploy
+
+      - name: Deploy EDGE
+        if: github.ref == 'refs/heads/dev'
+        uses: benc-uk/workflow-dispatch@e2e5e9a103e331dad343f381a29e654aea3cf8fc
+        with:
+          workflow: edge-deploy-shards.yml
+          repo: opf/saas-deploy
+          ref: master
+          inputs: '{ "hocuspocus_image_tag": "${{ env.DOCKER_TAG }}" }'
+          token: "${{ steps.generate-gha-token.outputs.token }}"
+
+      - name: Deploy STAGE
+        if: github.ref == 'refs/heads/release'
+        uses: benc-uk/workflow-dispatch@e2e5e9a103e331dad343f381a29e654aea3cf8fc
+        with:
+          workflow: stage-deploy-shards.yml
+          repo: opf/saas-deploy
+          ref: master
+          inputs: '{ "hocuspocus_image_tag": "${{ env.DOCKER_TAG }}" }'
+          token: "${{ steps.generate-gha-token.outputs.token }}"

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: test.yml
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  units:
+    name: Unit tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v5
+        with:
+          node-version: '22.19'
+          cache: npm
+          cache-dependency-path: package-lock.json
+
+      - name: Install Dependencies
+        id: npm-i
+        run: npm i
+
+      - name: run tests
+        id: npm-test
+        run: CI=1 npm test

README.md

@@ -1,10 +1,75 @@
 # op-blocknote-hocuspocus
 
-YJS provider for real time collaborative document editting in OpenProject
+[![Tests](https://github.com/opf/op-blocknote-hocuspocus/actions/workflows/test.yml/badge.svg)](https://github.com/opf/op-blocknote-hocuspocus/actions/workflows/test.yml)
+[![Docker](https://github.com/opf/op-blocknote-hocuspocus/actions/workflows/docker.yml/badge.svg)](https://github.com/opf/op-blocknote-hocuspocus/actions/workflows/docker.yml)
 
-Do not forget to setup the environment correctly. 
+A real-time collaborative editing server for [OpenProject](https://www.openproject.org/) documents, powered by [Yjs](https://github.com/yjs/yjs) and [Hocuspocus](https://tiptap.dev/docs/hocuspocus/introduction).
 
+## Installation
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/opf/op-blocknote-hocuspocus.git
+cd op-blocknote-hocuspocus
+
+# Install dependencies
+npm install
+
+# Start the server with the appropriate environment variables setup
+ALLOWED_DOMAINS=your-openproject-domain.com SECRET=secret12345 npm run start
+```
+
+For the server to be able to reach to an OpenProject instance, it is necessary to set the environment variable `ALLOWED_DOMAINS`. It is a comma-separated list of domains (and it allows subdomain matching).
+
+```
+ALLOWED_DOMAINS=subdomain-openproject.example.com,top-level-openproject.com`
 ```
-ALLOWED_DOMAINS=https://your-openproject-domain.com,https://another-allowed-domain.com
+
+The `SECRET` environment variable is a shared value between this application and OpenProject. Make sure to configure the same value in OpenProject - Settings Hocuspocus secret and in the `SECRET` environment variable of this project.
+
+### Using Docker
+
+```bash
+docker pull openproject/hocuspocus:latest
+
+docker run -d \
+  -p 1234:1234 \
+  -e ALLOWED_DOMAINS=your-openproject-domain.com \
+  -e SECRET=secret12345 \
+  openproject/hocuspocus:latest
 ```
 
+## Usage
+
+### Starting the Server
+
+```bash
+# Development Mode (with hot reload):
+npm run dev
+
+# Production Mode
+npm run start
+
+# Debug Mode (with Node.js inspector):
+npm run debug
+
+# Run tests
+npm run test
+
+# Lint code
+npm run lint
+```
+
+## Links
+
+- [OpenProject](https://www.openproject.org/)
+- [Hocuspocus Documentation](https://tiptap.dev/docs/hocuspocus/introduction)
+- [Yjs Documentation](https://docs.yjs.dev/)
+- [BlockNote Editor](https://www.blocknotejs.org/)
+- [Repository Issues](https://github.com/opf/op-blocknote-hocuspocus/issues)
+
+---
+
+**Maintained by the OpenProject team**