Repository navigation
docs: detail SPDX compatibility for license key #1022
Description
What needs to get done
Situation
The license key complies with SPDX, but the field's docs don't state that the value is a license expression, nor the constraints. Users might understand it to be a plain a string.
Request
In the license docstring:
- Mention that it's a compliant SPDX expression.
- Indicate that
ANDandORare supported. - Provide richer examples of the expression syntax.
- Link to the full SPDX spec.
Why it needs to get done
The constraints of the key aren't clear in the existing docs.
Reacted by Alex Lowe
Activity
syncronize-issues-to-jira commentedon Mar 9, 2026
Thank you for reporting your feedback to us!
The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-5045.
medubelko commentedon Mar 10, 2026
From @jahn-junior:
lengau commentedon Mar 12, 2026
Technically in craft-application this is just just a string. However, we provide the ability for apps to use
SpdxLicenseStr(which is actually a string containing a license expression, sigh). I believe only Rockcraft uses that currently.medubelko commentedon Mar 12, 2026
Should we override the text in the Rockcraft docs? It's inconvenient that the field is the same.