Skip to content

Extract and extend license and copyright #2959

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

giulio93
Copy link

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change, and is titled accordingly?

Other information

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

github-actions bot commented Jul 24, 2025

The latest Buf updates on your PR. Results from workflow Check Protocol Buffers / check (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedJul 25, 2025, 1:18 PM

@giulio93 giulio93 force-pushed the giulio93/copyright branch 5 times, most recently from f9540cc to 1b80d24 Compare July 24, 2025 13:14
@giulio93 giulio93 force-pushed the giulio93/copyright branch from 4edf904 to ed61192 Compare July 24, 2025 13:21
Copy link

codecov bot commented Jul 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.21%. Comparing base (cba02e8) to head (3140dd5).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2959      +/-   ##
==========================================
- Coverage   68.22%   68.21%   -0.02%     
==========================================
  Files         241      241              
  Lines       22696    22696              
==========================================
- Hits        15484    15481       -3     
- Misses       6012     6014       +2     
- Partials     1200     1201       +1     
Flag Coverage Δ
unit 68.21% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@giulio93 giulio93 force-pushed the giulio93/copyright branch 2 times, most recently from 62dd1a7 to 639bc19 Compare July 24, 2025 14:48
@giulio93 giulio93 marked this pull request as ready for review July 25, 2025 08:09
giulio93 and others added 6 commits July 25, 2025 15:17
Co-authored-by: Luca Rinaldi <lucarin@protonmail.com>
Co-authored-by: Luca Rinaldi <lucarin@protonmail.com>
@giulio93 giulio93 force-pushed the giulio93/copyright branch from a5aaceb to 3140dd5 Compare July 25, 2025 13:17
Comment on lines +24 to +38
append-license:
desc: Render and append arduino-cli license to NOTICE file
cmds:
- |
rendered=$(envsubst < .licenses/templates/arduino-cli-license.txt)
notice_file=".licenses/NOTICE.arduino-cli"
tmp_file=$(mktemp)
echo "$rendered" > "$tmp_file"
echo -e "\n" >> "$tmp_file"
cat "$notice_file" >> "$tmp_file"
mv "$tmp_file" "$notice_file"
env:
Year: '{{ now | date "2006" }}'
Holder: "ARDUINO SA (http://www.arduino.cc/)"
silent: false

Choose a reason for hiding this comment

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

I don't think this autogeneration system will be useful. I would just commit a copyright notice file without the env variable and use that during the build.

Suggested change
append-license:
desc: Render and append arduino-cli license to NOTICE file
cmds:
- |
rendered=$(envsubst < .licenses/templates/arduino-cli-license.txt)
notice_file=".licenses/NOTICE.arduino-cli"
tmp_file=$(mktemp)
echo "$rendered" > "$tmp_file"
echo -e "\n" >> "$tmp_file"
cat "$notice_file" >> "$tmp_file"
mv "$tmp_file" "$notice_file"
env:
Year: '{{ now | date "2006" }}'
Holder: "ARDUINO SA (http://www.arduino.cc/)"
silent: false

Choose a reason for hiding this comment

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

Can you remove the comments and move to another directory? I think the root directory is ok. I would also remove the env variables and just create a file with the copyright notice all filled up.

- mkdir -p debian/arduino-cli/usr/share/doc/arduino-cli/
- cat arduino-cli-license.txt > debian/arduino-cli/usr/share/doc/arduino-cli/copyright
- echo -e "\n\n---\n\n" >> debian/arduino-cli/usr/share/doc/arduino-cli/copyright
- cat /Users/sedia/repo/arduino-cli/.licenses/NOTICE.arduino-cli >> debian/arduino-cli/usr/share/doc/arduino-cli/copyright

Choose a reason for hiding this comment

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

Suggested change
- cat /Users/sedia/repo/arduino-cli/.licenses/NOTICE.arduino-cli >> debian/arduino-cli/usr/share/doc/arduino-cli/copyright
- cat .licenses/NOTICE.arduino-cli >> debian/arduino-cli/usr/share/doc/arduino-cli/copyright

- name: Build License
run: |
task extract-licenses
task append-license

Choose a reason for hiding this comment

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

Suggested change
task append-license

@@ -4,6 +4,39 @@ includes:
dist: ./DistTasks.yml

tasks:
extract-licenses:

Choose a reason for hiding this comment

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

I would call this task something like update-deb-copyright

@lucarin91 lucarin91 requested a review from per1234 July 25, 2025 15:23
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.

3 participants