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

Docs: Include a note about supported licenses in WordPress packages #66562

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Oct 29, 2024

What?

Follow-up for #66428.

Raise in the comments https://github.com/WordPress/gutenberg/pull/66428/files#r1816140475:

I think one aspect needs to be documented. Using wpScript or/and wpScriptModuleExports marks the package as production package for strict verification of compatibility with GPL license.

Why?

Ensure that production packages are marked accordingly.

How?

Include a note in the documentation.

@gziolo gziolo added [Type] Developer Documentation Documentation for developers npm Packages Related to npm packages labels Oct 29, 2024
@gziolo gziolo requested review from desrosj and swissspidy October 29, 2024 13:50
Copy link

github-actions bot commented Oct 29, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: gziolo <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: sirreal <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Flaky tests detected in 6dbc9ce.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11575325110
📝 Reported issues:

@@ -64,7 +64,7 @@ When creating a new package, you need to provide at least the following. Package
}
```

Both `wpScript` and `wpScriptModuleExports` may be included if the package exposes both a script and a script module.
Both `wpScript` and `wpScriptModuleExports` may be included if the package exposes both a script and a script module. These fields are also essential when performing a license check for all their dependencies, because they trigger strict validation against compatibility with GPL2. All remaining dependencies WordPress doesn't distribute but uses for development purposes can contain also a few other OSS compatible licenses.
Copy link
Member

Choose a reason for hiding this comment

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

What if a package is published to npm but not used in WordPress core itself as a script or script module. Wouldn't that still need to comply with the GPL?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a tricky one. I think @wordpress/react-i18n is one of these packages that isn't used in WordPress core but is still published to npm. I see it is annotated as wpScript 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

I landed as is but I’ll keep thinking how to better represent these meta information.

I have also started wondering whether all WordPress development packages can be considered GPL v2 if they depend on broader OSS compatible licenses. However it’s outside of my area expertise.

packages/README.md Outdated Show resolved Hide resolved
Co-authored-by: Pascal Birchler <[email protected]>
@gziolo gziolo merged commit 6d57cb4 into trunk Nov 5, 2024
63 of 64 checks passed
@gziolo gziolo deleted the update/docs-packages-licenses branch November 5, 2024 07:16
@github-actions github-actions bot added this to the Gutenberg 19.7 milestone Nov 5, 2024
karthick-murugan pushed a commit to karthick-murugan/gutenberg that referenced this pull request Nov 13, 2024
…ordPress#66562)

* Docs: Include a note about supported licenses in WordPress packages

* Update README.md

* Update packages/README.md

Co-authored-by: Pascal Birchler <[email protected]>

---------

Co-authored-by: Pascal Birchler <[email protected]>

Co-authored-by: gziolo <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: sirreal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
npm Packages Related to npm packages [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants