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: Apache 2にライセンスを変更 #1581

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Qs-F
Copy link
Collaborator

@Qs-F Qs-F commented May 6, 2024

User description

チケット

実装内容

  • LICENSEファイルを追加
  • MITからApache 2に変更
    • 企業の提供するOSSがMITであると特許まわりで問題が発生することがあるため
    • 株式会社Pixivのデザインシステムvibesを参考に変更
  • author情報を変更

スクリーンショット

変更前 変更後

相談内容(あれば)


PR Type

documentation, enhancement


Description

  • Added the full text of the Apache License Version 2.0 to the LICENSE file.
  • Updated the main package.json and sub-packages (eslint-config, for-ui, prettier-config) metadata to reflect the new author and license (Apache-2.0).
  • Added a changeset file to document these updates.

Changes walkthrough 📝

Relevant files
Documentation
giant-zoos-poke.md
Add Changeset for License Update                                                 

.changeset/giant-zoos-poke.md

  • Added a changeset file to document the license change to Apache 2.0.
  • +7/-0     
    LICENSE
    Add Apache License 2.0 Full Text                                                 

    LICENSE

    • Introduced the full Apache License Version 2.0 text.
    +201/-0 
    Enhancement
    package.json
    Update Main Package Metadata                                                         

    package.json

  • Updated author from 'locona ' to '3-shake, Inc.'
  • Changed license from MIT to Apache-2.0.
  • +2/-2     
    package.json
    Update ESLint Config Package Metadata                                       

    packages/eslint-config/package.json

    • Updated author and license in package metadata.
    +2/-2     
    package.json
    Update UI Package Metadata                                                             

    packages/for-ui/package.json

    • Updated author and license in package metadata.
    +2/-2     
    package.json
    Update Prettier Config Package Metadata                                   

    packages/prettier-config/package.json

    • Updated author and license in package metadata.
    +2/-2     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link

    changeset-bot bot commented May 6, 2024

    🦋 Changeset detected

    Latest commit: bbb5bf7

    The changes in this PR will be included in the next version bump.

    This PR includes changesets to release 3 packages
    Name Type
    @4design/eslint-config Patch
    @4design/for-ui Patch
    @4design/prettier-config Patch

    Not sure what this means? Click here to learn what changesets are.

    Click here if you're a maintainer who wants to add another changeset to this PR

    Copy link

    cloudflare-workers-and-pages bot commented May 6, 2024

    Deploying for-ui with  Cloudflare Pages  Cloudflare Pages

    Latest commit: bbb5bf7
    Status: ✅  Deploy successful!
    Preview URL: https://0bfa53da.for-ui.pages.dev
    Branch Preview URL: https://docs-license-change-apache-2.for-ui.pages.dev

    View logs

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    CI Failure Feedback 🧐

    Action: build-nextjs

    Failed stage: Run npm install --no-save turbo-linux-64 [❌]

    Failure summary:

    The action failed due to a JSON parsing error in the package.json file. Specifically, an unexpected
    token "A" was found at position 217, likely due to a syntax error around the license field which
    appears to be incorrectly formatted as "license": ""Apache-2.0",. Proper JSON format was not
    maintained, causing npm install to fail.

    Relevant error logs:
    1:  ##[group]Operating System
    2:  Ubuntu
    ...
    
    135:  Cache restored from key: node-cache-Linux-npm-9610f41d731e0f7299dbb42b0e7260c6f827c2ab5697999a5121a17b74ac8277
    136:  ##[group]Run npm install --no-save turbo-linux-64
    137:  �[36;1mnpm install --no-save turbo-linux-64�[0m
    138:  shell: /usr/bin/bash -e {0}
    139:  ##[endgroup]
    140:  npm ERR! code EJSONPARSE
    141:  npm ERR! path /home/runner/work/for-ui/for-ui/package.json
    142:  npm ERR! JSON.parse Unexpected token "A" (0x41) in JSON at position 217 while parsing near "...c.\",\n  \"license\": \"\"Apache-2.0\",\n  \"priv..."
    143:  npm ERR! JSON.parse Failed to parse JSON data.
    144:  npm ERR! JSON.parse Note: package.json must be actual JSON, not just JavaScript.
    145:  npm ERR! A complete log of this run can be found in:
    146:  npm ERR!     /home/runner/.npm/_logs/2024-05-06T13_24_30_814Z-debug-0.log
    147:  ##[error]Process completed with exit code 1.
    

    ✨ CI feedback usage guide:

    The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
    The tool analyzes the failed checks and provides several feedbacks:

    • Failed stage
    • Failed test name
    • Failure summary
    • Relevant error logs

    In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

    /checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
    

    where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

    Configuration options

    • enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
    • excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
    • enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
    • persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
    • final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

    See more information about the checks tool in the docs.

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    CI Failure Feedback 🧐

    Action: build-vite

    Failed stage: Run npm install --no-save turbo-linux-64 [❌]

    Failure summary:

    The action failed due to a JSON parsing error in the package.json file. Specifically, an unexpected
    token "A" was found at position 217, indicating a likely syntax error around the license field,
    where an extra quote appears before "Apache-2.0".

    Relevant error logs:
    1:  ##[group]Operating System
    2:  Ubuntu
    ...
    
    135:  Cache restored from key: node-cache-Linux-npm-9610f41d731e0f7299dbb42b0e7260c6f827c2ab5697999a5121a17b74ac8277
    136:  ##[group]Run npm install --no-save turbo-linux-64
    137:  �[36;1mnpm install --no-save turbo-linux-64�[0m
    138:  shell: /usr/bin/bash -e {0}
    139:  ##[endgroup]
    140:  npm ERR! code EJSONPARSE
    141:  npm ERR! path /home/runner/work/for-ui/for-ui/package.json
    142:  npm ERR! JSON.parse Unexpected token "A" (0x41) in JSON at position 217 while parsing near "...c.\",\n  \"license\": \"\"Apache-2.0\",\n  \"priv..."
    143:  npm ERR! JSON.parse Failed to parse JSON data.
    144:  npm ERR! JSON.parse Note: package.json must be actual JSON, not just JavaScript.
    145:  npm ERR! A complete log of this run can be found in:
    146:  npm ERR!     /home/runner/.npm/_logs/2024-05-06T13_24_33_580Z-debug-0.log
    147:  ##[error]Process completed with exit code 1.
    

    ✨ CI feedback usage guide:

    The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
    The tool analyzes the failed checks and provides several feedbacks:

    • Failed stage
    • Failed test name
    • Failure summary
    • Relevant error logs

    In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

    /checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
    

    where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

    Configuration options

    • enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
    • excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
    • enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
    • persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
    • final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

    See more information about the checks tool in the docs.

    @Qs-F Qs-F marked this pull request as ready for review May 7, 2024 07:52
    @Qs-F Qs-F requested a review from locona May 7, 2024 07:52
    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Description updated to latest commit (bbb5bf7)

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are mostly textual updates to the license and author information across multiple files. The complexity is low, and the changes are straightforward to verify.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No

    🔒 Security concerns

    No

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestions                                                                                                                                                       
    Possible issue
    Update the "author" field to reflect the correct authorship.

    Ensure that the "author" field in the package.json reflects the actual or legal author of
    the package, especially after a license change, to avoid potential legal issues.

    packages/eslint-config/package.json [9]

    -"author": "3-shake, Inc."
    +"author": "[Correct author name or entity]"
     
    Enhancement
    Adjust the versioning in the changeset to more accurately reflect the significance of the changes.

    Verify that the versioning and patch notes accurately reflect the changes made, especially
    in a significant update like a license change.

    .changeset/giant-zoos-poke.md [2-4]

    -"@4design/eslint-config": patch
    -"@4design/for-ui": patch
    -"@4design/prettier-config": patch
    +"@4design/eslint-config": minor
    +"@4design/for-ui": minor
    +"@4design/prettier-config": minor
     

    Copy link
    Contributor

    @locona locona left a comment

    Choose a reason for hiding this comment

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

    LGTM

    @locona
    Copy link
    Contributor

    locona commented Aug 12, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    @locona
    Copy link
    Contributor

    locona commented Aug 12, 2024

    No code documentation found to improve this PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    ライセンスをApache 2に変更
    2 participants