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

Move external licenses to separate directory #1648

Merged
merged 1 commit into from Jan 5, 2023

Conversation

charliermarsh
Copy link
Member

I received some feedback from a friend at Google that our license structure was failing to get picked up as MIT when run against the license auto-detection systems that make it easier for Google employees to contribute. This was the other structure I considered initially (add licenses to a subdirectory), so lets run with that instead.

@charliermarsh charliermarsh merged commit 9041423 into main Jan 5, 2023
@charliermarsh charliermarsh deleted the charlie/license-files branch January 5, 2023 01:07
renovate bot added a commit to ixm-one/pytest-cmake-presets that referenced this pull request Jan 5, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.210` ->
`^0.0.211` |
[![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.211/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.211/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.211/compatibility-slim/0.0.210)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.211/confidence-slim/0.0.210)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>charliermarsh/ruff</summary>

###
[`v0.0.211`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.211)

[Compare
Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.210...v0.0.211)

#### What's Changed

- Implement `SIM220` and `SIM221` by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1630
- Implement flake8-simplify SIM105 rule by
[@&#8203;messense](https://togithub.com/messense) in
[astral-sh/ruff#1621
- Fix `SIM105` by [@&#8203;harupy](https://togithub.com/harupy) in
[astral-sh/ruff#1633
- Adding my company to the "used in" category of the Readme. by
[@&#8203;colin99d](https://togithub.com/colin99d) in
[astral-sh/ruff#1631
- Implement flake8-bandit rule `S103` by
[@&#8203;edgarrmondragon](https://togithub.com/edgarrmondragon) in
[astral-sh/ruff#1636
- Rename flake8-bandit rules from plugins to checks by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1637
- Tweak Yoda condition message by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1638
- Note a few more incompatibilities by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1639
- Add task-tags & ignore-overlong-task-comments settings by
[@&#8203;not-my-profile](https://togithub.com/not-my-profile) in
[astral-sh/ruff#1550
- Add badge JSON by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1641
- Add Ruff badge to README by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1642
- DRY up unused import removal code by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1643
- Implement builtin import removal by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1645
- Move external licenses to separate directory by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1648
- Implement nested-if detection by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1649
- Implement flake8-bandit rule `S108` by
[@&#8203;edgarrmondragon](https://togithub.com/edgarrmondragon) in
[astral-sh/ruff#1644
- Implement nested with detection (SIM117) by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1651
- Cancel outdated in-progress workflow automatically by
[@&#8203;messense](https://togithub.com/messense) in
[astral-sh/ruff#1652
- Implement flake8-simplify SIM107 by
[@&#8203;messense](https://togithub.com/messense) in
[astral-sh/ruff#1650
- Implement `SIM110` and `SIM111` (conversion to `any` and `all`) by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1653

**Full Changelog**:
astral-sh/ruff@v0.0.210...v0.0.211

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC44MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuODEuMCJ9-->

Signed-off-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
license-files = [
"LICENSE",
"licenses/*",
]
Copy link
Member Author

Choose a reason for hiding this comment

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

@messense - Do you know if there's any way for Maturin to include these if I'm willing to manually enumerate them? (Even if they're not identified as "licenses" in any special way, but rather, just included in the distributed wheel in some form?)

Copy link
Contributor

Choose a reason for hiding this comment

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

You can use the tool.maturin.include option, see https://maturin.rs/metadata.html#add-maturin-build-options

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you :)

I'm finding that I have to do include = ["../licenses/*"] given our structure. Which gives me this slightly strange wheel:

Screen Shot 2023-01-25 at 1 24 49 PM

Would it be too weird of me to symlink licenses into python, to get this?

Screen Shot 2023-01-25 at 1 24 24 PM

Copy link
Member Author

Choose a reason for hiding this comment

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

@messense - Definitely not urgent, I decided to merge the licenses back into a single file (and was able to fix the broken license detector via some licensee hacks, I think).

Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be too weird of me to symlink licenses into python, to get this?

I think it's fine for now, in the future ruff-X.Y.Z.dist-info/license_files folder is the proper place to put them. [tool.maturin.include] doesn't support changing the path in wheel/sdist at the moment.

charliermarsh added a commit that referenced this pull request Jan 25, 2023
These were split into per-project licenses in #1648, but I don't like that they're no longer included in the distribution (due to current limitations in the `pyproject.toml` spec).
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.

None yet

2 participants