Bump rails-erd from 1.7.2 to 2.0.0

[dependabot]

Bumps rails-erd from 1.7.2 to 2.0.0.

Release notes

Sourced from rails-erd's releases.

v2.0.0 - The Mermaid Era 🧜‍♀️

Rails ERD 2.0.0 - The Mermaid Era 🧜‍♀️

It's alive! After years of quiet maintenance, Rails ERD is back with its biggest update ever.

This release fundamentally reimagines how Rails ERD works. No more wrestling with Graphviz installations, no more mysterious dot executable errors, no more platform-specific headaches. Just run bundle exec erd and get a beautiful diagram that renders right in your GitHub README, GitLab wiki, or Notion docs.

🌊 Why Mermaid?

Mermaid diagrams are text-based and render natively in:

• GitHub (READMEs, issues, PRs, wikis)
• GitLab (everywhere!)
• Notion, Obsidian, and countless other tools
• Any Markdown renderer with Mermaid support

No more generating PDFs, committing images, or explaining to teammates how to install Graphviz. Your ERD lives in version control as readable text and renders beautifully wherever you need it.

💥 Breaking Changes

Setting	Old Default	New Default
generator	graphviz	mermaid
filetype	pdf	mmd
mermaid_style	classdiagram	erdiagram
direction	RL (right-to-left)	TB (top-down)
ruby-graphviz	required	optional

🚀 Migration Guide

Most users: Just run bundle exec erd and enjoy your new Mermaid diagram!

To continue using Graphviz output:

# Gemfile
gem 'ruby-graphviz'

bundle exec erd generator=graphviz filetype=pdf

To use classDiagram style instead of erDiagram:

bundle exec erd mermaid_style=classdiagram

✨ New Features

• Mermaid erDiagram style with crow's foot notation and PK/FK markers (#445)
• Full CLI parity - CLI now supports all options that rake task supports (#446, #447)
• Orientation support - Mermaid direction respects the orientation option (#448)

... (truncated)

Changelog

Sourced from rails-erd's changelog.

2.0.0

Breaking Changes

• Default generator changed from Graphviz to Mermaid (#448)
• Default filetype changed from PDF to MMD (#448)
• Default mermaid_style changed from classDiagram to erDiagram (#448)
• Default direction changed from RL to TB (top-down) (#448)
• ruby-graphviz gem is now optional (#448)

New Features

• Mermaid erDiagram style with crow's foot notation and PK/FK markers (#445)
• CLI now supports all options that rake task supports (#446, #447)
• Mermaid direction respects orientation option (#448)

Bug Fixes

• Fix --only flag with single model (#441)
• Fix nil destination crash (#440)
• Fix empty .erdconfig crash (#443)
• Fix CLI string-to-symbol option conversion (#447)
• Exclude Rails 8 Solid* internal models (#437, #438, #439)
• Suppress Ruby 3.4 hash key warnings (#436)

Documentation

• Updated README for Mermaid as default (#444, #448)
• Added non-Rails usage example (#444)

Commits

• See full diff in compare view

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[github-actions]

Test coverage

91.72% line coverage reported by SimpleCov.
Run: https://github.com/RaspberryPiFoundation/editor-api/actions/runs/27766949441

[cursor]

Stale comment

Dependabot assessment: rails-erd 1.7.2 → 2.0.0

Verdict: Safe to merge for production/runtime. This is a lockfile-only bump; rails-erd is in the :development group and is not loaded in production.

CI

• lint: pass
• test (full rspec): pass
• Local Docker was unavailable here; verification relied on GitHub Actions.

Safety of merging

No application behaviour changes. The test suite does not exercise ERD generation, so these dev-tool concerns would not be caught by CI:

• Output format change: v2 defaults to Mermaid (.mmd) instead of Graphviz PDF. .erdconfig only sets filename/title, so bundle exec erd will now produce EditorAPI-ERD.mmd, not EditorAPI-ERD.pdf.
• README is stale: README.md still documents copying EditorAPI-ERD.pdf out of the container.
• Graphviz no longer bundled: ruby-graphviz is removed from the lockfile. Restoring PDF output requires re-adding that gem and passing generator=graphviz filetype=pdf.
• Diagram fidelity: large schemas may look different in Mermaid vs the old Graphviz PDF — worth a quick manual bundle exec erd after merge if anyone relies on the diagram.

Proposed fixes

Not required to merge; optional follow-ups:

• Update the README ERD section for .mmd output (and how to view/commit it), or
• Pin the old workflow in .erdconfig (generator: graphviz, filetype: pdf) and add ruby-graphviz back to the :development group if the team prefers PDFs.

No test failures, deprecations, or runtime fixes needed.

  

_{Sent by Cursor Automation: Editor-* - Tests Dependabot PRs}

[cursor]

Dependabot assessment: rails-erd 1.7.2 → 2.0.0

Verdict: safe to merge. Lockfile-only bump; CI lint and RSpec both pass (91.72% coverage). Local test run was not possible here (no Docker/Ruby in this environment); results are from GitHub Actions run #27679002784.

Safety of merging

• rails-erd is in the :development group only — no production or test runtime impact.
• No application code changes; existing test suite gives good confidence nothing loads this gem at runtime.
• Developer workflow change (not covered by tests): v2 defaults to Mermaid output (.mmd) instead of Graphviz PDF. The README still documents copying EditorAPI-ERD.pdf, and .erdconfig does not pin generator/filetype, so bundle exec erd will now produce a different artifact than documented.
• ruby-graphviz dropped from the lockfile. PDF generation still works if needed, but requires re-adding the gem and passing generator=graphviz filetype=pdf (or equivalent .erdconfig settings).

Proposed fixes

None required to merge. Optional follow-up:

• Update the README ERD section for the new Mermaid default (.mmd), or document the Graphviz/PDF migration path if that workflow should be preserved.
• If the team wants to keep PDF output: add ruby-graphviz back to the development group and set generator/filetype in .erdconfig or CLI docs.

No test failures, no new Ruby/Rails deprecations attributable to this bump.

  

_{Sent by Cursor Automation: Editor-* - Tests Dependabot PRs}

[cursor]

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

Want higher recall? High effort reviews run extra passes and find more bugs. A team admin can switch effort levels in the Cursor dashboard.

^{Reviewed by Cursor Bugbot for commit 2c1d2af. Configure here.}

[cursor]

ERD bump breaks PDF workflow

Medium Severity

Upgrading to rails-erd 2.0.0 switches the default output to Mermaid .mmd and drops the ruby-graphviz dependency, while .erdconfig still only sets filename: EditorAPI-ERD and the README still tells developers to copy EditorAPI-ERD.pdf from the container. bundle exec erd no longer creates that PDF path.

 

^{Reviewed by Cursor Bugbot for commit 2c1d2af. Configure here.}