Handle SPDX licences starting with a digit #10356
Draft
+29
−17
Conversation
This file contains 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
ffaf1
added
the
re: devx
geekosaur
approved these changes
Sep 14, 2024
ffaf1
added
the
attention: needs-backport in the future
ffaf1
force-pushed
the
spdx-handle-number
branch
from
e357e9f
to
3fac0c5
Compare
ulysses4ever
approved these changes
Sep 14, 2024
Any string that is short/recognizeable enough and does not clash is ok. I will change it to |
ffaf1
force-pushed
the
spdx-handle-number
branch
from
3fac0c5
to
bfe5e0a
Compare
ffaf1
added
squash+merge me
mergify
bot
added
the
merge delay passed
cabal has a devscript that parses a json file (containing SPDX licences) and returns a number of of Haskell data constructors. There have been problems when the SPDX short identifier starts with a digit (e.g. “0BSD”), as that would generate an data constructor starting with a digit, which is not valid Haskell. The way to handle such occourrences was in an ad-hoc basis. This patch prepends “N_” to the beginning of every SPDX licence starting with a digit, future-proofing the script.
Useless since we are going to have to do it again before a release, needed to make CI green (“Check that diff is clean”).
ffaf1
force-pushed
the
spdx-handle-number
branch
from
aa53d46
to
52b2082
Compare
|
@Kleidukos we decided to postpone this after the release. What is your opinion now? I remember you had some doubts about this having to involve the parser, but I forgot the specifics. |
|
My opinion was "let's not rush the modification of the SPDX generator, because it will fail us when we need to use it for lib:Cabal 3.14". Now the modification window is open and will close before 3.16 when we will have more urgent problems. |
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.
cabal has a devscript that parses a json file (containing SPDX licences) and returns a number of of Haskell data constructors.
There have been problems when the SPDX short identifier starts with a digit (e.g. “0BSD”), as that would generate an data constructor starting with a digit, which is not valid Haskell. The way to handle such occourrences was in an ad-hoc basis.
This patch prepends
N_to the beginning of every SPDX licence starting with a digit, future-proofing the script.Manual QA notes have been included.Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)This has not been done in #10341 not to incour in bugs or problems during release.
The patch is very simple but not trivial (we are retroactively changing some data constructors). Voice any concerns!
This should not be merged before 3.14 is released.
This should not need backbort.It needs a backport (specificaly: the changelog files) since it will case breaking changes to a datatype.No need for backport, the changelog files will just be picked normally during next release.