Consume Harmony via NuGet instead of submodule by hahn-kev · Pull Request #2354 · sillsdev/languageforge-lexbox

hahn-kev · 2026-06-12T09:39:16Z

Summary

Remove the backend/harmony git submodule; LexBox now depends on SIL.Harmony, SIL.Harmony.Core, and SIL.Harmony.Linq2db from NuGet (pinned in Directory.Packages.props).
Add MSBuild props for optional local source builds (UseHarmonySource=true, default sibling path ../harmony).
Simplify CI checkout and dev Dockerfiles; drop submodule init from task setup.

Test plan

dotnet build backend/LexBoxApi/LexBoxApi.csproj
dotnet build backend/FwLite/LcmCrdt/LcmCrdt.csproj
dotnet build backend/FwHeadless/FwHeadless.csproj
CI passes on this PR
Optional: verify UseHarmonySource=true with a local ../harmony clone

Co-authored-by: Cursor <cursoragent@cursor.com>

coderabbitai · 2026-06-12T09:39:25Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5c62fb5d-8695-49e3-823c-ae24e7ffbead

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

Removes the backend/harmony git submodule and replaces it with pinned NuGet references (SIL.Harmony, SIL.Harmony.Core, SIL.Harmony.Linq2db at 0.2.1-rc.202). Adds MSBuild props files implementing a UseHarmonySource switch for optional local source builds. All CI workflows, Dockerfiles, solution files, developer tooling, and AI agent instructions are updated to reflect the submodule removal.

Changes

Harmony submodule → NuGet + optional local source

Layer / File(s)	Summary
Harmony MSBuild props infrastructure and package pinning `backend/Harmony.props`, `backend/Harmony.App.References.props`, `backend/Harmony.Core.References.props`, `backend/Harmony.Linq2db.References.props`, `backend/Directory.Packages.props`, `backend/Directory.Build.props`, `backend/Directory.Build.props.user.example`, `.gitignore`	Introduces base properties (`RepoRoot`, `HarmonySourcePath`, `UseHarmonySource`) and three conditional reference props files that switch between `ProjectReference` and `PackageReference` with build-time validation targets. Pins all three SIL.Harmony packages to `0.2.1-rc.202`, imports `Harmony.props` globally, and provides a user example file for local source opt-in.
Consumer project files wired to shared Harmony props `backend/FwHeadless/FwHeadless.csproj`, `backend/FwLite/LcmCrdt/LcmCrdt.csproj`, `backend/LexBoxApi/LexBoxApi.csproj`, `backend/LexData/LexData.csproj`	Each project replaces its inline submodule `ProjectReference` with an MSBuild `Import` of the appropriate `Harmony*.References.props` file.
Git submodule removal and developer setup `.gitmodules`, `backend/harmony`, `Taskfile.yml`, `README.md`	Removes the `backend/harmony` submodule entry and recorded commit pointer. Drops git submodule init/update steps from the `setup` task and updates README setup bullets and backend resource links.
Solution and solution filter cleanup `LexBox.sln`, `FwLiteOnly.slnf`, `LexBoxOnly.slnf`	Removes `SIL.Harmony` and `SIL.Harmony.Core` project definitions, build configuration entries, and nested project folder mappings from the solution and both solution filters.
CI workflow and Dockerfile updates `.github/workflows/codeql.yml`, `.github/workflows/fw-lite.yaml`, `.github/workflows/integration-test.yaml`, `.github/workflows/lexbox-.yaml`, `backend/FwHeadless/dev.Dockerfile`, `backend/LexBoxApi/dev.Dockerfile`	Removes `submodules: true` from all `actions/checkout` steps across six workflows. Updates `fw-lite.yaml` path triggers from `backend/harmony/*` to `backend/Directory.Packages.props` and `backend/Harmony.props`. Replaces harmony-specific Dockerfile staging with a generic csproj relocation loop.
AI agent and developer docs `.claude/agents/harmony-sentinel.md`, `.claude/hooks/session-start.sh`, `.claude/skills/_shared/apply-rules.md`, `.claude/skills/_shared/dispatch-matrix.md`, `backend/AGENTS.md`	Rewrites `harmony-sentinel` instructions for NuGet/MSBuild review instead of submodule diffs, removes submodule init from the session hook, adds a `SIL.Harmony*` bump guard rule, updates the dispatch matrix routing, and adds local-source build instructions to `backend/AGENTS.md`.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

sillsdev/languageforge-lexbox#1558: Introduced centralized package management in backend/Directory.Packages.props, the same file where this PR adds SIL.Harmony version pins.
sillsdev/languageforge-lexbox#2346: Directly introduced the .claude/agents/harmony-sentinel.md and session-start.sh submodule init logic that this PR rewrites and removes.
sillsdev/languageforge-lexbox#1604: Modifies Taskfile.yml's setup task at the same location where this PR removes the git submodule init steps.

Suggested reviewers

myieye

Poem

🐇 No more submodule to clone and to track,
A NuGet package has now got our back!
With UseHarmonySource set to true,
Devs can still build from local source too.
The sentinel watches each version we pin —
Hop along, harmony, NuGet wins! 🎉

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Consume Harmony via NuGet instead of submodule' accurately and concisely summarizes the primary change: migrating from git submodule to NuGet package dependencies.
Description check	✅ Passed	The description clearly explains the main changes: removing the submodule, adding NuGet dependencies, introducing MSBuild props for optional local builds, and simplifying CI/dev processes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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 cursor/remove-harmony-submodule

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

github-actions · 2026-06-12T09:40:06Z

UI unit Tests

1 files ±0 62 suites ±0 27s ⏱️ -3s
186 tests ±0 186 ✅ ±0 0 💤 ±0 0 ❌ ±0
258 runs ±0 258 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit bac24cf. ± Comparison against base commit 248ea03.

♻️ This comment has been updated with latest results.

github-actions · 2026-06-12T09:41:35Z

C# FwHeadless Unit Tests

48 tests 48 ✅ 15s ⏱️
5 suites 0 💤
1 files 0 ❌

Results for commit bac24cf.

♻️ This comment has been updated with latest results.

github-actions · 2026-06-12T09:42:18Z

C# Unit Tests

165 tests 165 ✅ 20s ⏱️
23 suites 0 💤
1 files 0 ❌

Results for commit bac24cf.

♻️ This comment has been updated with latest results.

argos-ci · 2026-06-12T09:42:26Z

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	✅ No changes detected	-	Jun 18, 2026, 3:34 AM

# Conflicts: # backend/harmony

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@backend/Harmony.props`:
- Line 7: The HarmonySourcePath property definition uses
System.IO.Path::GetFullPath with backslash path separators which fails on
Linux/macOS platforms where backslashes are treated as literal characters.
Replace the System.IO.Path::GetFullPath call with MSBuild::NormalizePath in both
the RepoRoot property (line 6) and the HarmonySourcePath property (line 7) to
ensure cross-platform path composition compatibility with .NET 8+. This will
properly normalize path separators on all platforms without hardcoding
platform-specific backslashes.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: ca966302-8f6a-4360-a75e-b6a20968c469

📥 Commits

Reviewing files that changed from the base of the PR and between 248ea03 and 058dad3.

📒 Files selected for processing (32)

.claude/agents/harmony-sentinel.md
.claude/hooks/session-start.sh
.claude/skills/_shared/apply-rules.md
.claude/skills/_shared/dispatch-matrix.md
.github/workflows/codeql.yml
.github/workflows/fw-lite.yaml
.github/workflows/integration-test-gha.yaml
.github/workflows/integration-test.yaml
.github/workflows/lexbox-api.yaml
.github/workflows/lexbox-fw-headless.yaml
.gitignore
.gitmodules
FwLiteOnly.slnf
LexBox.sln
LexBoxOnly.slnf
README.md
Taskfile.yml
backend/AGENTS.md
backend/Directory.Build.props
backend/Directory.Build.props.user.example
backend/Directory.Packages.props
backend/FwHeadless/FwHeadless.csproj
backend/FwHeadless/dev.Dockerfile
backend/FwLite/LcmCrdt/LcmCrdt.csproj
backend/Harmony.App.References.props
backend/Harmony.Core.References.props
backend/Harmony.Linq2db.References.props
backend/Harmony.props
backend/LexBoxApi/LexBoxApi.csproj
backend/LexBoxApi/dev.Dockerfile
backend/LexData/LexData.csproj
backend/harmony

💤 Files with no reviewable changes (9)

.gitmodules
.github/workflows/lexbox-fw-headless.yaml
.github/workflows/lexbox-api.yaml
.github/workflows/codeql.yml
backend/harmony
.github/workflows/integration-test.yaml
.github/workflows/integration-test-gha.yaml
Taskfile.yml
LexBox.sln

hahn-kev and others added 3 commits June 12, 2026 16:34

Remove backend/harmony git submodule.

f2383fe

Co-authored-by: Cursor <cursoragent@cursor.com>

Consume Harmony via NuGet with optional local source mode.

110e4a5

Co-authored-by: Cursor <cursoragent@cursor.com>

remove commitId from IChange ts interface

203dffc

github-actions Bot added 💻 FW Lite issues related to the fw lite application, not miniLcm or crdt related 📦 Lexbox issues related to any server side code, fw-headless included labels Jun 12, 2026

Merge branch 'refs/heads/develop' into cursor/remove-harmony-submodule

058dad3

# Conflicts: # backend/harmony

hahn-kev requested a review from myieye June 15, 2026 02:56

myieye marked this pull request as ready for review June 17, 2026 12:40

myieye approved these changes Jun 17, 2026

View reviewed changes

coderabbitai Bot reviewed Jun 17, 2026

View reviewed changes

Comment thread backend/Harmony.props

Add migration adding new Commits index

bac24cf

hahn-kev merged commit f58948e into develop Jun 18, 2026
26 checks passed

hahn-kev deleted the cursor/remove-harmony-submodule branch June 18, 2026 04:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Consume Harmony via NuGet instead of submodule#2354

Consume Harmony via NuGet instead of submodule#2354
hahn-kev merged 5 commits into
developfrom
cursor/remove-harmony-submodule

hahn-kev commented Jun 12, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 12, 2026 •

edited

Loading

Review skipped

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

github-actions Bot commented Jun 12, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 12, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 12, 2026 •

edited

Loading

Uh oh!

argos-ci Bot commented Jun 12, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

hahn-kev commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

coderabbitai Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

github-actions Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

UI unit Tests

Uh oh!

github-actions Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

C# FwHeadless Unit Tests

Uh oh!

github-actions Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

C# Unit Tests

Uh oh!

argos-ci Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hahn-kev commented Jun 12, 2026 •

edited

Loading

coderabbitai Bot commented Jun 12, 2026 •

edited

Loading

github-actions Bot commented Jun 12, 2026 •

edited

Loading

github-actions Bot commented Jun 12, 2026 •

edited

Loading

github-actions Bot commented Jun 12, 2026 •

edited

Loading

argos-ci Bot commented Jun 12, 2026 •

edited

Loading