sillsdev / sillsdev/chorus

Patch release 5.1.1: cap L10NSharp below v9 to fix TypeLoadException

Open
#371 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
5
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Problem

Chorus 5.1.0 was compiled against L10NSharp 5.x, which placed L10NSharpExtender in the L10NSharp.UI namespace inside L10NSharp.dll. The NuGet dependency was an open minimum (>= 5.0.0), so NuGet will resolve to L10NSharp 9.x if it is present in a consuming project.

L10NSharp v9 moved L10NSharpExtender to the L10NSharp.Windows.Forms namespace in a separate L10NSharp.Windows.Forms.dll. The old type no longer exists in L10NSharp.dll, causing a TypeLoadException at runtime when any Chorus UI form is loaded:

Could not load type 'L10NSharp.UI.L10NSharpExtender' from assembly 'L10NSharp, Version=9.0.0.0, Culture=neutral, PublicKeyToken=fd0b3e309a5b7c28'

Fix

Branch patch/5.1.1-l10nsharp-v9 (one commit off v5.1.0) tightens the constraint to [5.0.0, 9.0.0), preventing NuGet from resolving to the incompatible v9.

To publish a 5.1.1 patch release

  1. Check out the branch:
    git checkout patch/5.1.1-l10nsharp-v9
    
  2. Tag it:
    git tag v5.1.1
    git push origin v5.1.1
    
  3. The existing CI/CD pipeline should pick up the tag and publish the NuGet packages. Verify that SIL.Chorus.LibChorus 5.1.1 appears on NuGet with the corrected [5.0.0, 9.0.0) L10NSharp constraint.

Notes

  • No code or designer-file changes are needed — the old L10NSharp.UI API is intact in v5–v8.
  • Users who need L10NSharp v9+ compatibility should migrate to Chorus 6.x (which references L10NSharp 10.0.0-* and uses the new L10NSharp.Windows.Forms namespace).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the patch/5.1.1-l10nsharp-v9 branch against v5.1.0 and inspect its package dependency metadata. Follow the listed tag and CI/CD flow, then verify that SIL.Chorus.LibChorus 5.1.1 is published on NuGet with the [5.0.0, 9.0.0) L10NSharp constraint.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
release
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.