Skip to content

build(deps): bump mermaid to v11.12.0#478

Merged
2bndy5 merged 1 commit intojbms:mainfrom
ruslo:pr.mermaid
Dec 3, 2025
Merged

build(deps): bump mermaid to v11.12.0#478
2bndy5 merged 1 commit intojbms:mainfrom
ruslo:pr.mermaid

Conversation

@ruslo
Copy link
Contributor

@ruslo ruslo commented Dec 1, 2025

I tried to add a (fancy) diagram created by https://mermaid.live/, but it didn't render. The reason is an old version of mermaid. Updating to version 11.12.0, which is currently used at https://mermaid.live/, seems to fix the issue.

Tested it on Ubuntu 24.04:

$ lsb_release -a
Distributor ID:  Ubuntu
Description:     Ubuntu 24.04.3 LTS
Release:         24.04
Codename:        noble

Fetch source code:

$ git clone git@github.com:jbms/sphinx-immaterial
$ cd sphinx-immaterial/

Install uv package manager and Graphviz (for dot):

$ sudo apt update
$ sudo apt install snapd
$ sudo snap install astral-uv --classic
$ sudo apt install graphviz

Run build:

$ uvx nox -s build

Build documentation:

$ uvx nox -s docs --forcecolor

HTML index file location:

$ ls ./docs/_build/html/index.html

If you want, I can add these instructions to https://github.com/jbms/sphinx-immaterial/blob/main/CONTRIBUTING.md for convenience.

2bndy5
2bndy5 previously requested changes Dec 1, 2025
Copy link
Collaborator

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

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

You forgot to update the package.lock file. Locally, you need to run npm install (at repo root).

@ruslo
Copy link
Contributor Author

ruslo commented Dec 1, 2025

You forgot to update the package.lock file. Locally, you need to run npm install (at repo root).

Okay, I see, it changed after I ran uvx nox -s build. Added to commit 👌

@2bndy5
Copy link
Collaborator

2bndy5 commented Dec 1, 2025

Can you post the output for hte following commands?

node --version

We're currently still on node v20.x.

I ask because there seems to be some unexpected updates in the lock file.

@ruslo
Copy link
Contributor Author

ruslo commented Dec 1, 2025

Can you post the output for hte following commands?

node --version

$ node --version
v20.12.1

@2bndy5 2bndy5 dismissed their stale review December 1, 2025 06:58

resolved

@codecov
Copy link

codecov bot commented Dec 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.10%. Comparing base (bcdcf4f) to head (099da1d).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #478   +/-   ##
=======================================
  Coverage   82.10%   82.10%           
=======================================
  Files          65       65           
  Lines        8654     8654           
=======================================
  Hits         7105     7105           
  Misses       1549     1549           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@2bndy5
Copy link
Collaborator

2bndy5 commented Dec 1, 2025

Ok, thanks. They must be transitive dependencies or the latest versions that satisfy the constraints.

@2bndy5 2bndy5 changed the title package.json: Update 'mermaid' to v11.12.0 build(deps): bump mermaid to v11.12.0 Dec 1, 2025
@2bndy5
Copy link
Collaborator

2bndy5 commented Dec 2, 2025

If you want, I can add these instructions to https://github.com/jbms/sphinx-immaterial/blob/main/CONTRIBUTING.md for convenience.

Sure, but as a separate PR. It should probably go under a section titled "Building this project's docs". Although, I would try to keep the instructions agnostic to any platform. Personally, I hate using snap packages. I would prefer to replace

  • instruction about necessary dev tools with links to their respective official install docs (uv and graphviz).

    Also, please add info about node.js needed, but instead of hard-coding the node.js version in CONTRIBUTING.md, I'd recommend installing fnm or some tool that respects a .node-version file in project root (which would need to be added).

  • "Run build" command with a "Setup python venv" command: uv sync.

    Because, running uv run nox depends on nox being present (in the project specific venv), and the docs session (-s docs) automatically installs python deps for building our docs in a separate nox venv.

    BTW, --forcecolor is only used to add color to stdout for non-interactive terminal sessions.

    TBH, I think the uv sync command could be skipped altogether because uv run automatically does uv sync as long as UV_NO_SYNC env var is not set (and --no-sync is not passed explicitly to uv run). But, its probably better to keep this uv sync instruction explicitly needed.


This reminds me that the tests snapshots need to be updated using a Linux OS (for various reasons), but that info would go in the tests/README.rst.

@ruslo
Copy link
Contributor Author

ruslo commented Dec 3, 2025

Sure, but as a separate PR

See #479

@2bndy5 2bndy5 merged commit b7389b5 into jbms:main Dec 3, 2025
26 checks passed
@ruslo ruslo deleted the pr.mermaid branch December 4, 2025 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants