Skip to content
This repository has been archived by the owner on Aug 22, 2024. It is now read-only.

annotations: Distribute the license with the crate #1221

Merged
merged 1 commit into from
Jun 16, 2023
Merged

annotations: Distribute the license with the crate #1221

merged 1 commit into from
Jun 16, 2023

Conversation

dm0-
Copy link
Contributor

@dm0- dm0- commented Jun 15, 2023

Description

This just adds license-file to the annotations crate pointed at the license in the parent directory. Since rust-lang/cargo#7905, this will distribute the license text in the crate so it is available with the code fetched from crates.io. (It could be added to the other Cargo.tomls, too, but mirai-annotations is the only one I see being published on crates.io from a quick search.)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • API change with a documentation update
  • Additional test coverage
  • Code cleanup or just keeping up with the latest Rustc nightly

How Has This Been Tested?

Run cargo package --list to verify the LICENSE file will be added, and also just cargo package to inspect it.

Checklist:

  • Fork the repo and create your branch from main.
  • If you've added code that should be tested, add tests.
  • If you've changed APIs, update the documentation.
  • Ensure the test suite passes.
  • Make sure your code lints.
  • If you haven't already, complete your CLA here: https://code.facebook.com/cla

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 15, 2023
@dm0-
Copy link
Contributor Author

dm0- commented Jun 15, 2023

I've updated this to use a symlink to copy the license into the crate instead, since defining license-file semantically means it's a nonstandard license apparently. If symlinks should be avoided, the file could be copied.

@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Merging #1221 (caa26d2) into main (41b3c94) will increase coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main   #1221   +/-   ##
=====================================
  Coverage     74%     74%           
=====================================
  Files         23      23           
  Lines      16537   16537           
=====================================
+ Hits       12337   12338    +1     
+ Misses      4200    4199    -1     

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@hermanventer hermanventer merged commit 957af25 into facebookexperimental:main Jun 16, 2023
@dm0- dm0- deleted the license branch June 16, 2023 03:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants