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

Support specifying multiple license files and other text files for the Hex tarball #3040

Open
PgBiel opened this issue Apr 24, 2024 · 5 comments
Labels
discussion The approach has not yet been decided priority:low

Comments

@PgBiel
Copy link
Contributor

PgBiel commented Apr 24, 2024

Currently, we only upload a single LICENSE to Hex, as seen in the code below.

add("LICENSE");
add("LICENCE");
add("LICENSE.md");
add("LICENCE.md");
add("LICENSE.txt");
add("LICENCE.txt");

However, I have projects which are dual-licensed under MIT and Apache-2.0, so it would be nice to allow uploading LICENSE-* to Hex when publishing as well (in my case LICENSE-MIT and LICENSE-APACHE, exact naming might vary).

Not sure what's Hex's policy on this, but worth considering.

@lpil
Copy link
Member

lpil commented Apr 24, 2024

SPDX defines expressions for this. Does that work?

@PgBiel
Copy link
Contributor Author

PgBiel commented Apr 24, 2024

That's an improvement for sure! Though I think that might not be enough (to just upload the LICENSE with the SPDX expression), as MIT requires distribution of the full license file, apparently (so I'd upload LICENSE, LICENSE-MIT and LICENSE-APACHE). I am not a lawyer, however.

@lpil
Copy link
Member

lpil commented Apr 24, 2024

You could put them both in the same file, or in the readme, or in the code. I don't believe either states the manner in which you include them.

We could also have a feature for adding additional text files to the tarball.

@PgBiel
Copy link
Contributor Author

PgBiel commented Apr 24, 2024

You could put them both in the same file, or in the readme, or in the code. I don't believe either states the manner in which you include them.

Fair enough.

We could also have a feature for adding additional text files to the tarball.

This sounds like a good idea in general (I guess that'd avoid this kind of issue in the future, for the most part at least).

Could probably be in the form of an array in gleam.toml with additional relative paths to include.

@lpil
Copy link
Member

lpil commented Apr 24, 2024

Sounds good to me!

@lpil lpil added discussion The approach has not yet been decided priority:low labels Apr 24, 2024
@lpil lpil changed the title Support uploading dual-licensed projects' licenses to Hex Support specifying multiple license files and other text files for the Hex tarball Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion The approach has not yet been decided priority:low
Projects
None yet
Development

No branches or pull requests

2 participants