Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SPDX headers? #72

Open
rossabaker opened this issue Jan 17, 2022 · 7 comments
Open

SPDX headers? #72

rossabaker opened this issue Jan 17, 2022 · 7 comments

Comments

@rossabaker
Copy link
Member

I have swallowed a bunch of defaults I don't like in the interest of comity, but typelevel/jawn#402 has me wondering about whether this is our opportunity to wave the flag for SPDX. It accomplishes the same, is more terse, and is machine readable. SPDX is good.

@rossabaker
Copy link
Member Author

We should crap or get off the pot on this one before we migrate too many more projects.

@armanbilge
Copy link
Member

armanbilge commented Jan 18, 2022

I would merge a PR that makes this change 👍

With that said, once we have a prePR command and we teach Scala Steward to run it for us, we should be able to make changes like this and propagate them without manual intervention. See also:

@rossabaker
Copy link
Member Author

I'm less worried about being able to do it and more worried about defaults churn now that this has been rolled out to more than a couple obscure repositories.

@armanbilge
Copy link
Member

Fair enough. But it would already be a sort of defaults churn since for most/all repos the de-facto default seems to be non-SPDX headers.

@rossabaker
Copy link
Member Author

Yeah, that's a fair point. I was focued on the repos that have no headers.

There should be a high bar to changing defaults, and this appears to be one that only I care about.

@DavidGregory084
Copy link
Member

I had a quick look at this one and it seems like it could be awkward as I don't think sbt-header will regenerate existing headers into the new style in headerCreate, but it will complain about them using the wrong style for headerCheck.

All I did to test this was to add the headerLicenseStyle to the projectSettings of TypelevelPlugin in sbt-typelevel, so it might be that more configuration was needed.

@rossabaker
Copy link
Member Author

This is when http4s migrated from SPDX to the default: https://github.com/Banno/mobile-data-services/pull/8954. I wish I remembered whether that regeneration commit just worked or if I did black sed magic to strip the original header before recreating. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants