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

chore(derive): include license files #170

Merged
merged 1 commit into from
Oct 26, 2023
Merged

chore(derive): include license files #170

merged 1 commit into from
Oct 26, 2023

Conversation

decathorpe
Copy link
Contributor

I am packaging the prometheus-client and prometheus-client-derive-encode crates for Fedora Linux. I noticed that the latter crate does not contain license files as it is published to crates.io.

However, both the terms of the MIT and Apache-2.0 licenses require that any (re)distributed sources contain a copy of the original license text. This is potentially problematic for the crates as published on crates.io, but definitely problematic for packaging them on Linux distributions.

This PR includes symbolic links to both license files in the derive-encode directory, which should result in "cargo package" / "cargo publish" including a copy of the license files when publishing to crates.io. This is assuming that the publishing workflow is run on an operating system that supports symbolic links - if publishing happens on Windows, full copies of the license texts might be required instead of a symbolic link.

@mxinden
Copy link
Member

mxinden commented Oct 25, 2023

Thank you for the patch and thank you for packaging prometheus-client. I suggest copying the files for the sake of simplicity. Also, CI is currently failing on the DCO step.

@decathorpe
Copy link
Contributor Author

Thanks for your feedback - I've changed the PR to use copies instead of symlinks.

As for the DCO, it looks like I need to add a "Signed-off-by" line to the commits. What am I signing off on by doing that, exactly? I couldn't find any documentation for that.

@mxinden
Copy link
Member

mxinden commented Oct 25, 2023

Fair question. You can find more details here https://probot.github.io/apps/dco/.

As far as I know this is a legal requirement forced upon the project. Personally I find it very annoying. That said, it might be more useful than I think, i.e. I might be misjudging the legal risk the project might face without.

@decathorpe
Copy link
Contributor Author

Thanks for the link, now the signoff thing makes sense! I've added it to the commit.

Copy link
Member

@mxinden mxinden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Thanks.

@mxinden mxinden changed the title Include license files when publishing the derive-encode crate chore(derive): include license files Oct 26, 2023
@mxinden mxinden merged commit d897372 into prometheus:master Oct 26, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants