From b6a4e1203e015aefec13fa17ced890d836a0b574 Mon Sep 17 00:00:00 2001 From: Christoph Mussenbrock Date: Tue, 27 May 2025 15:34:47 +0000 Subject: [PATCH] feat: add Apache 2.0 license and update package.json files --- .github/workflows/release.yml | 43 ++++++-- LICENSE | 200 ++++++++++++++++++++++++++++++++++ package.json | 1 + packages/ui-kit/package.json | 1 + 4 files changed, 237 insertions(+), 8 deletions(-) create mode 100644 LICENSE diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 574d48c..3fe4aa9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -88,37 +88,64 @@ jobs: VERSION_NO_V=${VERSION#v} cd packages/ui-kit - npm pkg set name="@etherisc/ui-kit" - npm pkg set version="${VERSION_NO_V}" - npm pkg set private=false - npm pkg set publishConfig.registry="https://npm.pkg.github.com" - npm pkg set repository.type="git" - npm pkg set repository.url="git+https://github.com/${{ github.repository }}.git" + + # Create a backup of the original package.json + cp package.json package.json.backup + + # Update package.json using jq for reliable JSON manipulation + jq --arg name "@etherisc/ui-kit" \ + --arg version "${VERSION_NO_V}" \ + --arg repo_url "git+https://github.com/${{ github.repository }}.git" \ + '.name = $name | + .version = $version | + .private = false | + .publishConfig.registry = "https://npm.pkg.github.com" | + .repository.type = "git" | + .repository.url = $repo_url' \ + package.json > package.json.tmp && mv package.json.tmp package.json + + echo "Updated package.json for publishing:" + cat package.json | jq '.name, .version, .private, .publishConfig, .repository' - name: Publish to GitHub Packages run: | cd packages/ui-kit npm publish + + # Restore original package.json + mv package.json.backup package.json + echo "Restored original package.json" env: NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Setup Pages uses: actions/configure-pages@v4 + with: + enablement: true + continue-on-error: true - name: Upload to GitHub Pages uses: actions/upload-pages-artifact@v3 with: path: packages/ui-kit/storybook-static + continue-on-error: true - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 + continue-on-error: true - name: Generate release notes run: | VERSION="${{ steps.version.outputs.version }}" BUILD_HASH="${{ steps.build-hash.outputs.hash }}" + # Set default page URL if deployment failed + PAGE_URL="${{ steps.deployment.outputs.page_url }}" + if [ -z "$PAGE_URL" ]; then + PAGE_URL="https://github.com/${{ github.repository }}/tree/main/packages/ui-kit/storybook-static" + fi + cat > release-notes.md << EOF # UI Kit ${VERSION} @@ -143,7 +170,7 @@ jobs: - **Performance**: Bundle size monitoring (< 250KB gzipped) ### 📚 Documentation - - [Storybook Demo](${{ steps.deployment.outputs.page_url }}) + - [Storybook Demo](${PAGE_URL}) - [Contributing Guide](https://github.com/${{ github.repository }}/blob/main/CONTRIBUTING.md) - [Design Tokens](https://github.com/${{ github.repository }}/blob/main/DESIGN_TOKENS.md) @@ -155,7 +182,7 @@ jobs: ### 🔗 Links - **Package**: [GitHub Packages](https://github.com/${{ github.repository }}/packages) - - **Demo**: [Storybook](${{ steps.deployment.outputs.page_url }}) + - **Demo**: [Storybook](${PAGE_URL}) - **Build**: \`${BUILD_HASH}\` --- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..70dd7ff --- /dev/null +++ b/LICENSE @@ -0,0 +1,200 @@ + 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 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 control, "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" shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" 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 + (which shall not include communications that are marked or + otherwise designated in writing by the copyright owner as + "Not a Contribution"). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based upon (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." + + 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 use, reproduce, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Work, and to + permit persons to whom the Work is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Work. + + 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, trademark, patent, + attribution and other 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" 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 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 notice 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 Support. You may choose to offer, and to + charge a fee for, warranty, support, 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 support. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in comments for the + particular file format. We also recommend that a file or class name + and description of purpose be included on the same "printed page" + as the copyright notice for easier identification within third-party + archives. + + Copyright 2025 Etherisc + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/package.json b/package.json index 17011f8..551c063 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "ui-kit-monorepo", "private": true, "type": "module", + "license": "Apache-2.0", "workspaces": [ "packages/*" ], diff --git a/packages/ui-kit/package.json b/packages/ui-kit/package.json index 971eed3..fd11782 100644 --- a/packages/ui-kit/package.json +++ b/packages/ui-kit/package.json @@ -3,6 +3,7 @@ "version": "0.1.0-beta", "private": true, "type": "module", + "license": "Apache-2.0", "main": "./dist/ui-kit.umd.cjs", "module": "./dist/ui-kit.js", "types": "./dist/index.d.ts",