From 7948ed317aaf9a3033029f30c1e5144a6d4b95ab Mon Sep 17 00:00:00 2001 From: Frank Chen Date: Thu, 11 Jun 2026 10:30:19 -0700 Subject: [PATCH] fix: add legal files back to built packages --- .github/scripts/check_dist_legal_files.py | 76 ++++++++ .github/workflows/ci.yml | 6 + .github/workflows/pypi-publish.yml | 3 + .../pyproject.toml | 8 + .../LICENSE | 175 ------------------ .../NOTICE | 1 - .../README.md | 2 +- .../pyproject.toml | 8 + .../README.md | 4 +- .../pyproject.toml | 8 + 10 files changed, 112 insertions(+), 179 deletions(-) create mode 100644 .github/scripts/check_dist_legal_files.py delete mode 100644 packages/aws-durable-execution-sdk-python-testing/LICENSE delete mode 100644 packages/aws-durable-execution-sdk-python-testing/NOTICE diff --git a/.github/scripts/check_dist_legal_files.py b/.github/scripts/check_dist_legal_files.py new file mode 100644 index 00000000..fdf8d3b6 --- /dev/null +++ b/.github/scripts/check_dist_legal_files.py @@ -0,0 +1,76 @@ +#!/usr/bin/env python3 +"""Verify built distributions include LICENSE and NOTICE files.""" + +from __future__ import annotations + +import sys +import tarfile +import zipfile +from pathlib import Path + + +REQUIRED_BASENAMES = {"LICENSE", "NOTICE"} + + +def list_archive_names(archive_path: Path) -> list[str]: + if archive_path.suffix == ".whl": + with zipfile.ZipFile(archive_path) as archive: + return archive.namelist() + + if archive_path.suffixes[-2:] == [".tar", ".gz"]: + with tarfile.open(archive_path) as archive: + return archive.getnames() + + raise ValueError(f"Unsupported distribution type: {archive_path}") + + +def verify_package(package_dir: Path) -> list[str]: + dist_dir = package_dir / "dist" + errors: list[str] = [] + + if not dist_dir.is_dir(): + return [f"{package_dir}: missing dist directory"] + + archives = sorted( + path + for path in dist_dir.iterdir() + if path.is_file() + and (path.suffix == ".whl" or path.suffixes[-2:] == [".tar", ".gz"]) + ) + if not archives: + return [f"{package_dir}: no built distributions found"] + + for archive_path in archives: + names = list_archive_names(archive_path) + basenames = {Path(name).name for name in names} + missing = sorted(REQUIRED_BASENAMES - basenames) + if missing: + errors.append(f"{archive_path}: missing {', '.join(missing)}") + + return errors + + +def main(argv: list[str]) -> int: + if len(argv) < 2: + print( + "usage: check_dist_legal_files.py [ ...]", + file=sys.stderr, + ) + return 2 + + errors: list[str] = [] + for arg in argv[1:]: + errors.extend(verify_package(Path(arg))) + + if errors: + for error in errors: + print(error, file=sys.stderr) + return 1 + + for arg in argv[1:]: + print(f"{arg}: LICENSE and NOTICE found in all distributions") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv)) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2e4f2992..e400e92a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -67,3 +67,9 @@ jobs: cd "$GITHUB_WORKSPACE" fi done + - name: Verify legal files in published distributions + run: | + python .github/scripts/check_dist_legal_files.py \ + packages/aws-durable-execution-sdk-python \ + packages/aws-durable-execution-sdk-python-otel \ + packages/aws-durable-execution-sdk-python-testing diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml index 42c66f83..0217b1d5 100644 --- a/.github/workflows/pypi-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -44,6 +44,9 @@ jobs: working-directory: ${{ matrix.package.path }} run: hatch build + - name: Verify legal files in release distributions + run: python .github/scripts/check_dist_legal_files.py ${{ matrix.package.path }} + - name: Upload distributions uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: diff --git a/packages/aws-durable-execution-sdk-python-otel/pyproject.toml b/packages/aws-durable-execution-sdk-python-otel/pyproject.toml index 72d64176..500880ec 100644 --- a/packages/aws-durable-execution-sdk-python-otel/pyproject.toml +++ b/packages/aws-durable-execution-sdk-python-otel/pyproject.toml @@ -34,9 +34,17 @@ Documentation = "https://github.com/aws/aws-durable-execution-sdk-python#readme" Issues = "https://github.com/aws/aws-durable-execution-sdk-python/issues" Source = "https://github.com/aws/aws-durable-execution-sdk-python" +[tool.hatch.build.targets.sdist.force-include] +"../../LICENSE" = "LICENSE" +"../../NOTICE" = "NOTICE" + [tool.hatch.build.targets.wheel] packages = ["src/aws_durable_execution_sdk_python_otel"] +[tool.hatch.build.targets.wheel.force-include] +"../../LICENSE" = "aws_durable_execution_sdk_python_otel/LICENSE" +"../../NOTICE" = "aws_durable_execution_sdk_python_otel/NOTICE" + [tool.hatch.version] path = "src/aws_durable_execution_sdk_python_otel/__about__.py" diff --git a/packages/aws-durable-execution-sdk-python-testing/LICENSE b/packages/aws-durable-execution-sdk-python-testing/LICENSE deleted file mode 100644 index 67db8588..00000000 --- a/packages/aws-durable-execution-sdk-python-testing/LICENSE +++ /dev/null @@ -1,175 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. diff --git a/packages/aws-durable-execution-sdk-python-testing/NOTICE b/packages/aws-durable-execution-sdk-python-testing/NOTICE deleted file mode 100644 index 616fc588..00000000 --- a/packages/aws-durable-execution-sdk-python-testing/NOTICE +++ /dev/null @@ -1 +0,0 @@ -Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/packages/aws-durable-execution-sdk-python-testing/README.md b/packages/aws-durable-execution-sdk-python-testing/README.md index 223f07c1..4731527c 100644 --- a/packages/aws-durable-execution-sdk-python-testing/README.md +++ b/packages/aws-durable-execution-sdk-python-testing/README.md @@ -196,4 +196,4 @@ tldr; use `hatch` and it will manage virtual envs and dependencies for you, so y ## License -This project is licensed under the [Apache-2.0 License](LICENSE). +This project is licensed under the [Apache-2.0 License](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/LICENSE). diff --git a/packages/aws-durable-execution-sdk-python-testing/pyproject.toml b/packages/aws-durable-execution-sdk-python-testing/pyproject.toml index 5153fea3..559e6fa5 100644 --- a/packages/aws-durable-execution-sdk-python-testing/pyproject.toml +++ b/packages/aws-durable-execution-sdk-python-testing/pyproject.toml @@ -37,9 +37,17 @@ dex-local-runner = "aws_durable_execution_sdk_python_testing.cli:main" [tool.hatch.build.targets.sdist] packages = ["src/aws_durable_execution_sdk_python_testing"] +[tool.hatch.build.targets.sdist.force-include] +"../../LICENSE" = "LICENSE" +"../../NOTICE" = "NOTICE" + [tool.hatch.build.targets.wheel] packages = ["src/aws_durable_execution_sdk_python_testing"] +[tool.hatch.build.targets.wheel.force-include] +"../../LICENSE" = "aws_durable_execution_sdk_python_testing/LICENSE" +"../../NOTICE" = "aws_durable_execution_sdk_python_testing/NOTICE" + [tool.hatch.metadata] allow-direct-references = true diff --git a/packages/aws-durable-execution-sdk-python/README.md b/packages/aws-durable-execution-sdk-python/README.md index 3a772717..419a49a5 100644 --- a/packages/aws-durable-execution-sdk-python/README.md +++ b/packages/aws-durable-execution-sdk-python/README.md @@ -4,7 +4,7 @@ [![PyPI - Version](https://img.shields.io/pypi/v/aws-durable-execution-sdk-python.svg)](https://pypi.org/project/aws-durable-execution-sdk-python) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aws-durable-execution-sdk-python.svg)](https://pypi.org/project/aws-durable-execution-sdk-python) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/aws/aws-durable-execution-sdk-python/badge)](https://scorecard.dev/viewer/?uri=github.com/aws/aws-durable-execution-sdk-python) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/LICENSE) ----- @@ -82,4 +82,4 @@ The complete documentation for the AWS Durable Execution SDK for Python lives on ## 📄 License -See the [LICENSE](LICENSE) file for our project's licensing. +See the [LICENSE](https://github.com/aws/aws-durable-execution-sdk-python/blob/main/LICENSE) file for our project's licensing. diff --git a/packages/aws-durable-execution-sdk-python/pyproject.toml b/packages/aws-durable-execution-sdk-python/pyproject.toml index ab059a02..62e80764 100644 --- a/packages/aws-durable-execution-sdk-python/pyproject.toml +++ b/packages/aws-durable-execution-sdk-python/pyproject.toml @@ -28,9 +28,17 @@ Documentation = "https://github.com/aws/aws-durable-execution-sdk-python#readme" Issues = "https://github.com/aws/aws-durable-execution-sdk-python/issues" Source = "https://github.com/aws/aws-durable-execution-sdk-python" +[tool.hatch.build.targets.sdist.force-include] +"../../LICENSE" = "LICENSE" +"../../NOTICE" = "NOTICE" + [tool.hatch.build.targets.wheel] packages = ["src/aws_durable_execution_sdk_python"] +[tool.hatch.build.targets.wheel.force-include] +"../../LICENSE" = "aws_durable_execution_sdk_python/LICENSE" +"../../NOTICE" = "aws_durable_execution_sdk_python/NOTICE" + [tool.hatch.version] path = "src/aws_durable_execution_sdk_python/__about__.py"