Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Repository: https://github.com/suitenumerique/docs
- `src/mail/` - Email templates (MJML)
- `src/helm/` - Kubernetes/Helm deployment

## Dev instance (TypeCellOS fork)

This fork deploys a dev instance from the `dev` branch. It uses preview packages
of BlockNote. `deploy/dev-instance/README.md` explains how to deploy, and how to
update BlockNote ("Update BlockNote").

## Development Commands

### Setup and Services
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ and this project adheres to
### Changed

- 🛂(backend) let users allowed to comment list each other's accesses #2447
- ⬆️(frontend) update BlockNote preview packages to 3b7d4ec140
- ⬆️(frontend) update BlockNote preview packages to 83153fda2e
- ♻️(frontend) restore bounded editor history through native yhub rollback
- ♻️(frontend) use standalone YHub version storage and history extension
- ♻️(frontend) migrate the history panel to RenderInPortalElement
Expand Down
44 changes: 44 additions & 0 deletions deploy/dev-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,50 @@ ssh deploy@167.233.225.101 'grep -E "^(SEED_PASSWORD_ADMIN|KEYCLOAK_ADMIN_PASSWO
To deploy a branch that is not merged, run the "Dev instance" workflow from the
Actions tab and set `ref`. There is only one server: the last deploy wins.

## Update BlockNote

The frontend and y-provider use preview packages of BlockNote from
[pkg.pr.new](https://pkg.pr.new). They come from the BlockNote branch
`fix/version-diff-cascade-attribution`, draft pull request
[TypeCellOS/BlockNote#3204](https://github.com/TypeCellOS/BlockNote/pull/3204):
BlockNote `main` plus the experimental version diff fixes. Do not merge that
pull request.

1. In BlockNote, merge `main` into `fix/version-diff-cascade-attribution` and
push. Resolve conflicts in favour of `main`, except in the experimental code
(`packages/core/src/y/extensions/snapshotPreview.ts`, the experimental tests,
and the gallery flags). Then update the gallery snapshot:
`pnpm run e2e:updateSnaps src/end-to-end/y-prosemirror/versioning.test.tsx`.
2. Wait until the `build` workflow of #3204 passes. Its "Soft release" step
publishes the packages under the first 10 characters of the commit SHA.
pkg.pr.new publishes only for an open pull request, so keep #3204 open.
Check a package:

```bash
curl -s -o /dev/null -w "%{http_code}\n" \
https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@<new sha>
```

3. In this repository, replace the old SHA with the new one and update
`yarn.lock`:

```bash
git switch -c chore/blocknote-<new sha> origin/dev
sed -i '' 's/<old sha>/<new sha>/g' CHANGELOG.md \
src/frontend/package.json \
src/frontend/apps/impress/package.json \
src/frontend/servers/y-provider/package.json
cd src/frontend && yarn install --ignore-engines
```

`yarn.lock` must change only the `@blocknote/*` entries.
4. Commit as `⬆️(frontend) update BlockNote preview packages to <new sha>`
(signed off), open a pull request against `dev`, and merge it. The merge
deploys.

The `test-e2e-chromium` job fails on every run of this fork. Compare its
failures with the previous update pull request instead of waiting for green.

## Server

- The stack is in `/opt/docs` (`compose.yaml`). The `deploy` user owns it.
Expand Down
22 changes: 11 additions & 11 deletions src/frontend/apps/impress/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@
"dependencies": {
"@ag-media/react-pdf-table": "2.0.3",
"@ai-sdk/openai": "3.0.119",
"@blocknote/code-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/code-block@3b7d4ec140",
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@3b7d4ec140",
"@blocknote/diagram-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/diagram-block@3b7d4ec140",
"@blocknote/mantine": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/mantine@3b7d4ec140",
"@blocknote/math-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/math-block@3b7d4ec140",
"@blocknote/react": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/react@3b7d4ec140",
"@blocknote/xl-ai": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-ai@3b7d4ec140",
"@blocknote/xl-docx-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-docx-exporter@3b7d4ec140",
"@blocknote/xl-multi-column": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-multi-column@3b7d4ec140",
"@blocknote/xl-odt-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-odt-exporter@3b7d4ec140",
"@blocknote/xl-pdf-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-pdf-exporter@3b7d4ec140",
"@blocknote/code-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/code-block@83153fda2e",
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@83153fda2e",
"@blocknote/diagram-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/diagram-block@83153fda2e",
"@blocknote/mantine": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/mantine@83153fda2e",
"@blocknote/math-block": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/math-block@83153fda2e",
"@blocknote/react": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/react@83153fda2e",
"@blocknote/xl-ai": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-ai@83153fda2e",
"@blocknote/xl-docx-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-docx-exporter@83153fda2e",
"@blocknote/xl-multi-column": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-multi-column@83153fda2e",
"@blocknote/xl-odt-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-odt-exporter@83153fda2e",
"@blocknote/xl-pdf-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-pdf-exporter@83153fda2e",
"@dnd-kit/core": "6.3.1",
"@dnd-kit/modifiers": "9.0.0",
"@emoji-mart/data": "1.2.1",
Expand Down
12 changes: 6 additions & 6 deletions src/frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@
"react": "19.3.0",
"react-dom": "19.3.0",
"serialize-javascript": "7.1.2",
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@3b7d4ec140",
"@blocknote/react": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/react@3b7d4ec140",
"@blocknote/xl-multi-column": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-multi-column@3b7d4ec140",
"@blocknote/xl-docx-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-docx-exporter@3b7d4ec140",
"@blocknote/xl-odt-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-odt-exporter@3b7d4ec140",
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@83153fda2e",
"@blocknote/react": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/react@83153fda2e",
"@blocknote/xl-multi-column": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-multi-column@83153fda2e",
"@blocknote/xl-docx-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-docx-exporter@83153fda2e",
"@blocknote/xl-odt-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-odt-exporter@83153fda2e",
"@blocknote/xl-typst-compiler": "0.55.0",
"@blocknote/xl-typst-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-typst-exporter@3b7d4ec140",
"@blocknote/xl-typst-exporter": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/xl-typst-exporter@83153fda2e",
"sharp": "0.35.4",
"typescript": "6.0.3",
"wrap-ansi": "10.0.2",
Expand Down
4 changes: 2 additions & 2 deletions src/frontend/servers/y-provider/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"node": ">=22"
},
"dependencies": {
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@3b7d4ec140",
"@blocknote/server-util": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/server-util@3b7d4ec140",
"@blocknote/core": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/core@83153fda2e",
"@blocknote/server-util": "https://pkg.pr.new/TypeCellOS/BlockNote/@blocknote/server-util@83153fda2e",
"@sentry/node": "10.75.0",
"@sentry/profiling-node": "10.75.0",
"@tiptap/extensions": "*",
Expand Down
Loading