Split the licence so GitHub can read it - #291
Merged
Merged
Conversation
GitHub reports this repository's licence as "Other". LICENSE.md carries the BSD-3-Clause text and a Japanese translation of it under a horizontal rule, and the detector compares the whole file against known licence texts -- the translation is about 40% of it, so nothing matches. The English text moves out on its own and the translation becomes LICENSE.ja.md, labelled a reference translation with the English named as authoritative. The leading SPDX-License-Identifier line goes too: it is content the detector has to account for as well, nothing in the tree parses it, and the point of this change is to leave no reason for a near-miss. Falling out of that, the two locale licence pages stop being the same page. docs/ja/license.md included LICENSE.md, so a Japanese reader was served the English text with its translation appended, and an English reader the reverse. Each now includes its own. Release packaging carries both files: LICENSE.ja.md joins LICENSE.md in the addon root and in addons/spritestudio/licenses/, and in the archive check that proves they arrived.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This repository is public, and GitHub reports its licence as Other:
LICENSE.mdholds the BSD-3-Clause text followed by a Japanese translation of itunder a horizontal rule. GitHub's detector compares the whole file against known
licence texts; the translation is about 40% of it, so nothing matches within the
confidence threshold.
Consequences beyond the sidebar label:
license:bsd-3-clausesearch never findsthe repository, dependency scanners and SBOM tooling that read the licence API
cannot classify it, and anyone checking licence compatibility has to open the
file and read it themselves.
Measured, not guessed
licensee10.1.0 — the detector GitHub runs — against each candidate file.Its match threshold is 98%.
LICENSE.mdcontainsSPDX-License-IdentifierlineLICENSE.ja.mdbeside itTwo things this settles:
declaration and other tooling (REUSE, ScanCode, SBOM generators) does key off it,
but
licenseemeasures how close the file is to a known licence text — so adeclaration line only dilutes it. One line costs six points and flips the verdict.
The identifier belongs somewhere else; the SDK already carries it as
license = "BSD-3-Clause"inCargo.toml.LICENSE.ja.mdsitting next to it changes nothing. The translation is safewhere it is.
What changed
LICENSE.mdis now the BSD-3-Clause text alone.LICENSE.ja.mdcarries the translation, labelled a reference translation withthe English named as authoritative.
SPDX-License-Identifierline is gone — see above. Nothing in thetree parsed it (
git grep SPDXfound only that line).Two things fall out of the split:
docs/ja/license.mdanddocs/en/license.mdboth--8<--includedLICENSE.md, so a Japanese readergot the English text with a translation appended and an English reader got the
reverse. Each now includes its own file.
LICENSE.ja.mdjoinsLICENSE.mdin theaddon root and in
addons/spritestudio/licenses/, in all four build scripts,and in the archive check that proves they arrived.
Known: the margin is 0.35 points
98.35% against a threshold of 98%. The gap is clause 3, which names the company
where the canonical text says "the copyright holder"; restoring the canonical
wording measures 100.00%. Left alone here — that is a change to licence text, and
the same wording is in all ten repositories. Worth knowing that a later edit to
this file could drop it back under.
What this does not prove yet
GitHub runs licence detection against the default branch, so the label only
moves once this is merged. That is the point of doing it here first: this is the
one public repository, and the same
LICENSE.mdsits in all ten. If it turns intoBSD-3-Clause after merge, the same split rolls out to the other nine.
Checks
pwshparses both.ps1scripts;bash -n/zsh -nparse both shell scripts.scripts/build-runtime.*still copies the SDK's ownLICENSE.mdintoss_player/runtime/. That file is the SDK's and is still bilingual — it followswhen SpriteStudio-SDK gets the same treatment.