Skip to content

fix: docs build failure and deploy only on release#321

Merged
driessamyn merged 1 commit into
mainfrom
fix/docs-build
Mar 25, 2026
Merged

fix: docs build failure and deploy only on release#321
driessamyn merged 1 commit into
mainfrom
fix/docs-build

Conversation

@driessamyn
Copy link
Copy Markdown
Owner

@driessamyn driessamyn commented Mar 25, 2026

Summary

  • Fix VitePress build failure caused by unescaped generic types (List<Int>, List<Long>) in docs/guide/mapping.md
  • Update docs workflow to build on PRs (for validation) but only deploy on release publish or manual trigger

Test plan

  • Local VitePress build passes
  • PR triggers docs build job (no deploy)
  • Manual workflow_dispatch deploys docs for 1.8.0

Summary by CodeRabbit

  • Documentation

    • Improved code formatting in the mapping guide documentation.
  • Chores

    • Updated CI/CD workflow configuration to refine deployment triggers and path-based execution conditions.

- Escape generic types in mapping.md to fix VitePress build
- Trigger docs build on PRs (paths: docs/**, core/src/**, coroutines/src/**)
- Deploy docs only on release publish or manual workflow_dispatch
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 928ff8b9-9558-4ac4-be78-b52a2f9c2a47

📥 Commits

Reviewing files that changed from the base of the PR and between f40f29c and c122f45.

📒 Files selected for processing (2)
  • .github/workflows/docs.yml
  • docs/guide/mapping.md

📝 Walkthrough

Walkthrough

Modified GitHub Actions workflow to trigger on pull requests with path filters for specific directories, added release trigger support, and made the deploy job conditional to skip on PR events. Updated documentation formatting for code examples.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
.github/workflows/docs.yml
Switched trigger from push to pull_request on main branch with path filters for docs/**, core/src/**, and coroutines/src/**. Added release trigger for published releases. Made deploy job conditional to skip execution on pull request events.
Documentation Formatting
docs/guide/mapping.md
Applied inline code formatting (backticks) to List<Int> and List<Long> type references in example guidance text.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A workflow springs to life so neat,
With pull requests and paths so sweet,
Docs formatted in backtick grace,
CI/CD hops at measured pace! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly addresses the two main changes: fixing a docs build failure and ensuring deployment only occurs on release events, matching the core objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-build

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

Unit Tests

 61 files  ±0   61 suites  ±0   3m 14s ⏱️ +17s
545 tests ±0  545 ✅ ±0  0 💤 ±0  0 ❌ ±0 
561 runs  ±0  561 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit c122f45. ± Comparison against base commit f40f29c.

This pull request removes 39 and adds 39 tests. Note that renamed tests count towards both.
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [10] LONGVARCHAR, "LONGVARCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1127/0x00007f473057e880@b021a08
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [11] NCHAR, "NCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1128/0x00007f473057eaa0@1e2a5d19
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [12] INSTANT, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$974/0x00007f4730545000@52f23a6c
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [12] NCLOB, "NCLOB", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1129/0x00007f473057ecc0@75641522
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [13] DATE, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$975/0x00007f4730545220@4764204e
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [13] NVARCHAR, "NVARCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1130/0x00007f473057eee0@74763ca3
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [14] LOCALDATE, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$976/0x00007f4730545440@1d6ffe6f
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [14] ROWID, "ROWID", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1131/0x00007f473057f100@4afe30c9
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [15] LOCALDATETIME, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$977/0x00007f4730545660@528e9784
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [15] SQLXML, "SQLXML", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1132/0x00007f473057f320@5864b221
…
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [10] LONGVARCHAR, "LONGVARCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1111/0x00007fdb94587c48@2f21714d
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [11] NCHAR, "NCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1112/0x00007fdb9458c000@4ad30c64
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [12] INSTANT, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$961/0x00007fdb94555c28@4cfc8818
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [12] NCLOB, "NCLOB", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1113/0x00007fdb9458c220@13ef3e89
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [13] DATE, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$962/0x00007fdb94555e48@4cf6d52c
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [13] NVARCHAR, "NVARCHAR", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1114/0x00007fdb9458c440@22a58147
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [14] LOCALDATE, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$963/0x00007fdb94556068@11330fa0
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [14] ROWID, "ROWID", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1115/0x00007fdb9458c660@4527441d
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [15] LOCALDATETIME, net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$964/0x00007fdb94556288@737f7159
net.samyn.kapper.internal.automapper.SQLTypesConverterTest ‑ [15] SQLXML, "SQLXML", net.samyn.kapper.internal.automapper.SQLTypesConverterTest$Companion$$Lambda$1116/0x00007fdb9458c880@4105e8e1
…

@github-actions
Copy link
Copy Markdown

Code Coverage

Total Project Coverage 98.37%

@driessamyn driessamyn merged commit 4cc9255 into main Mar 25, 2026
16 checks passed
@driessamyn driessamyn deleted the fix/docs-build branch March 25, 2026 22: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.

1 participant