Add license header file and script #1256

michael-valdron · 2023-09-18T14:00:44Z

What does this PR do?

Adds the license header file containing the license header which should be included under all source files. In addition, a the add_licenses.sh script is included to automate the process of adding license headers to all Go source files.

Which issue(s) does this PR fix

fixes #1104

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

Open new test/doc issues under the devfile/api repo

Check each criteria if:

There is a separate tracking issue. Add the issue link under the criteria
or

test/doc updates are made as part of this PR

If unchecked, explain why it's not needed

Unit/Functional tests
QE Integration test
Documentation
Client Impact

How to test changes / Special notes to the reviewer

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron · 2023-09-18T14:08:54Z

Unit/Functional tests

QE Integration test

Client Impact

I feel these are N/A to these changes.

yangcao77 · 2023-09-18T14:37:16Z

you may want to add license to existing files as well.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron · 2023-09-18T20:21:19Z

you may want to add license to existing files as well.

fixed in 471ff66

codecov · 2023-09-18T23:15:50Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (f331a0b) 35.79% compared to head (88feb0f) 35.79%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1256   +/-   ##
=======================================
  Coverage   35.79%   35.79%           
=======================================
  Files          52       52           
  Lines        6679     6679           
=======================================
  Hits         2391     2391           
  Misses       4144     4144           
  Partials      144      144

Files Changed	Coverage Δ
.../apis/workspaces/v1alpha1/attributes_conversion.go	`34.61% <ø> (ø)`
...kg/apis/workspaces/v1alpha1/commands_conversion.go	`74.07% <ø> (ø)`
...workspaces/v1alpha1/component_plugin_conversion.go	`19.14% <ø> (ø)`
.../apis/workspaces/v1alpha1/components_conversion.go	`70.21% <ø> (ø)`
pkg/apis/workspaces/v1alpha1/conversion.go	`74.28% <ø> (ø)`
...pis/workspaces/v1alpha1/devworkspace_conversion.go	`0.00% <ø> (ø)`
pkg/apis/workspaces/v1alpha1/devworkspace_types.go	`100.00% <ø> (ø)`
...spaces/v1alpha1/devworkspacetemplate_conversion.go	`0.00% <ø> (ø)`
.../workspaces/v1alpha1/devworkspacetemplate_types.go	`100.00% <ø> (ø)`
pkg/apis/workspaces/v1alpha1/events_conversion.go	`100.00% <ø> (ø)`
... and 34 more

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

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron · 2023-09-18T23:22:27Z

failing validation on generated source fixed in 829a3e8

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron · 2023-09-18T23:31:44Z

add_license.sh no longer includes generated source when appending license headers: 6802642

maysunfaisal · 2023-09-19T20:13:56Z

.github/workflows/che.yaml

+#
+#
+# Copyright Red Hat
+#


I wonder if we need to really add copyright to workflow scripts.. Do folks usually do this?

For our repos, this can be a bit hit or miss, for this repo none of them, for registry-support there's https://github.com/devfile/registry-support/blob/a95cc889ecaf131b2ce76535ff9d9179607240be/.github/workflows/ci.yaml.

As for the open source standard for this, I'm not sure. I will investigate what other projects are doing and can revert these if its not something we want to do.

These do not have license headers under the workflows:

gin-gonic/gin (MIT)

kubernetes/minikube (Apache)

microsoft/vscode (MIT)

containers/podman (Apache)

redhat-developer/odo (Apache)

These do have license headers under the workflows:

containers/podman-desktop (Apache)

eclipse/che (EPL)

Looks like most don't do it, including odo.

After reviewing Red Hat legal's recommendation for license header inclusion, I feel we should keep the license headers here.

maysunfaisal · 2023-09-21T15:51:45Z

license_header.txt

@@ -0,0 +1,15 @@
+
+
+Copyright Red Hat


One other small question, I noticed we are removing the years, curious as to why..

During devtools week discussions (Sep 11-15) we decided to make this change to follow Red Hat legal's guidelines on copyright labeling under the license headers.

michael-valdron · 2023-09-21T16:47:51Z

Unit/Functional tests

QE Integration test

Checked because these passed but there are no changes here that should effect the test cases from passing.

Client Impact

Leaving unchecked as there is no client impact from these changes.

michael-valdron · 2023-09-21T16:54:30Z

Changing the WIP: #1104 (comment)

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron · 2023-09-21T20:56:29Z

Changing the WIP: #1104 (comment)

Addressed in 8dfc215, 88feb0f

openshift-ci · 2023-09-22T19:51:39Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: maysunfaisal, michael-valdron

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

michael-valdron · 2023-09-22T19:55:15Z

cc: @amisevsk

michael-valdron · 2023-09-25T16:04:26Z

cc: @amisevsk

Based on the slack thread discussion I feel we can merge this now.

* 2.2.0 release cut Signed-off-by: Stephanie <yangcao@redhat.com> * enable gosec (#969) * enable gosec Signed-off-by: Kim Tsao <ktsao@redhat.com> * Fix G601 errors Signed-off-by: Kim Tsao <ktsao@redhat.com> * Fix warnings Signed-off-by: Kim Tsao <ktsao@redhat.com> * Add newline Signed-off-by: Kim Tsao <ktsao@redhat.com> Signed-off-by: Kim Tsao <ktsao@redhat.com> * Update the devfile spec to 2.2.1 alpha (#980) Signed-off-by: Paul Schultz <pschultz@pobox.com> * Bump kubernetes-client/gen revision to fix git dubious ownership error (#1045) * bump kubernetes-client/gen revision to fix git dubious ownership error Signed-off-by: Michael Valdron <mvaldron@redhat.com> * whitespace changes. Signed-off-by: Michael Valdron <mvaldron@redhat.com> * set openapi generator ref to version which supports typescript generation. Signed-off-by: Michael Valdron <mvaldron@redhat.com> --------- Signed-off-by: Michael Valdron <mvaldron@redhat.com> * Fix Dependabot issues (#1047) * fix dependabot issues, requires a bump in k8s versions Signed-off-by: Kim Tsao <ktsao@redhat.com> * re-generated devworkspace files Signed-off-by: Kim Tsao <ktsao@redhat.com> * Vendor updates Signed-off-by: Kim Tsao <ktsao@redhat.com> --------- Signed-off-by: Kim Tsao <ktsao@redhat.com> * fix gosec v2.14.0 (#1034) Signed-off-by: Michael Valdron <mvaldron@redhat.com> * Update python runtime version for `release-typescript-models` job (#1051) * bump python runtime version for 'release-typescript-models' job. Signed-off-by: Michael Valdron <mvaldron@redhat.com> * bump setup-python action to v4 for 'release-typescript-models' job. Signed-off-by: Michael Valdron <mvaldron@redhat.com> --------- Signed-off-by: Michael Valdron <mvaldron@redhat.com> * Add workflow for managing stale issues & PRs (#1055) Adds a GitHub workflow for managing stale & rotten issues and PRs. Issues & PRs are marked stale after 90 days of inactivity. After 60 further days, they are marked as rotten and closed. * Clarify hotReloadCapable field (#1091) * Clarify hotReloadCapable field Signed-off-by: Philippe Martin <phmartin@redhat.com> * Auto-generated Signed-off-by: Philippe Martin <phmartin@redhat.com> * Specify isDefault Signed-off-by: Philippe Martin <phmartin@redhat.com> * Clarify description Signed-off-by: Philippe Martin <phmartin@redhat.com> --------- Signed-off-by: Philippe Martin <phmartin@redhat.com> * update kubernetes/openshift endpoint validation (#1098) * update endpoint validation Signed-off-by: Stephanie <yangcao@redhat.com> * update unit test Signed-off-by: Stephanie <yangcao@redhat.com> * update the test error check to be more clear Signed-off-by: Stephanie <yangcao@redhat.com> * add unit test for two kube components Signed-off-by: Stephanie <yangcao@redhat.com> --------- Signed-off-by: Stephanie <yangcao@redhat.com> * Update release doc (#1110) Signed-off-by: Kim Tsao <ktsao@redhat.com> * Update directly executed scripts inside workflows (#1107) * Update directly executed scripts on workflows Signed-off-by: thepetk <thepetk@gmail.com> * Update directly executed scripts on bash scripts Signed-off-by: thepetk <thepetk@gmail.com> --------- Signed-off-by: thepetk <thepetk@gmail.com> * Add area alizer label to all issue templates (#1149) Signed-off-by: thepetk <thepetk@gmail.com> * Update deprecated github actions to latest version (#1231) * Update deprecated github actions Signed-off-by: thepetk <thepetk@gmail.com> * Remove jsonschema dep from validate samples Signed-off-by: thepetk <thepetk@gmail.com> --------- Signed-off-by: thepetk <thepetk@gmail.com> * Add license header file and script (#1256) * add license header file Signed-off-by: Michael Valdron <mvaldron@redhat.com> * addlicense script Signed-off-by: Michael Valdron <mvaldron@redhat.com> * update README with instructions on adding license headers Signed-off-by: Michael Valdron <mvaldron@redhat.com> * update license headers under source files Signed-off-by: Michael Valdron <mvaldron@redhat.com> * remove license header from generated source Signed-off-by: Michael Valdron <mvaldron@redhat.com> * add_license.sh ignores zz_generated.* source files Signed-off-by: Michael Valdron <mvaldron@redhat.com> * check license headers script added Signed-off-by: Michael Valdron <mvaldron@redhat.com> * check license headers script added to CI workflow Signed-off-by: Michael Valdron <mvaldron@redhat.com> --------- Signed-off-by: Michael Valdron <mvaldron@redhat.com> * add signoff Signed-off-by: Stephanie <yangcao@redhat.com> --------- Signed-off-by: Stephanie <yangcao@redhat.com> Signed-off-by: Kim Tsao <ktsao@redhat.com> Signed-off-by: Paul Schultz <pschultz@pobox.com> Signed-off-by: Michael Valdron <mvaldron@redhat.com> Signed-off-by: Philippe Martin <phmartin@redhat.com> Signed-off-by: thepetk <thepetk@gmail.com> Co-authored-by: Kim Tsao <84398375+kim-tsao@users.noreply.github.com> Co-authored-by: Paul Schultz <pschultz@pobox.com> Co-authored-by: Michael Valdron <michael.valdron@gmail.com> Co-authored-by: Michael Valdron <mvaldron@redhat.com> Co-authored-by: John Collier <jcollier@redhat.com> Co-authored-by: Philippe Martin <phmartin@redhat.com> Co-authored-by: Theofanis Petkos <thepetk@gmail.com>

michael-valdron added 3 commits September 18, 2023 00:35

add license header file

e08a3c1

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

addlicense script

85263aa

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

update README with instructions on adding license headers

7074439

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron requested review from amisevsk, yangcao77 and johnmcollier as code owners September 18, 2023 14:00

michael-valdron mentioned this pull request Sep 18, 2023

Devfile API repo missing license header #1104

Closed

3 tasks

update license headers under source files

471ff66

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

remove license header from generated source

829a3e8

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

michael-valdron force-pushed the feat/license-header branch from 5200a4f to 829a3e8 Compare September 18, 2023 23:20

add_license.sh ignores zz_generated.* source files

6802642

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

maysunfaisal reviewed Sep 19, 2023

View reviewed changes

michael-valdron mentioned this pull request Sep 20, 2023

Release changes for OLM validation devfile/registry-operator#49

Merged

4 tasks

michael-valdron requested a review from maysunfaisal September 20, 2023 20:27

maysunfaisal reviewed Sep 21, 2023

View reviewed changes

maysunfaisal approved these changes Sep 21, 2023

View reviewed changes

openshift-ci bot assigned maysunfaisal Sep 21, 2023

openshift-ci bot added the lgtm label Sep 21, 2023

michael-valdron changed the title ~~Add license header file and script~~ [WIP]Add license header file and script Sep 21, 2023

openshift-ci bot added the do-not-merge/work-in-progress label Sep 21, 2023

michael-valdron added 2 commits September 21, 2023 16:52

check license headers script added

8dfc215

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

check license headers script added to CI workflow

88feb0f

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

openshift-ci bot removed the lgtm label Sep 21, 2023

michael-valdron changed the title ~~[WIP]Add license header file and script~~ Add license header file and script Sep 21, 2023

openshift-ci bot removed the do-not-merge/work-in-progress label Sep 21, 2023

michael-valdron requested a review from maysunfaisal September 21, 2023 20:56

maysunfaisal approved these changes Sep 22, 2023

View reviewed changes

openshift-ci bot added the lgtm label Sep 22, 2023

michael-valdron merged commit e05a235 into devfile:main Sep 25, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add license header file and script #1256

Add license header file and script #1256

michael-valdron commented Sep 18, 2023 •

edited

Loading

michael-valdron commented Sep 18, 2023

yangcao77 commented Sep 18, 2023

michael-valdron commented Sep 18, 2023

codecov bot commented Sep 18, 2023 •

edited

Loading

michael-valdron commented Sep 18, 2023

michael-valdron commented Sep 18, 2023

maysunfaisal Sep 19, 2023

michael-valdron Sep 20, 2023

michael-valdron Sep 20, 2023

michael-valdron Sep 20, 2023

maysunfaisal Sep 21, 2023

michael-valdron Sep 21, 2023

michael-valdron commented Sep 21, 2023

michael-valdron commented Sep 21, 2023 •

edited

Loading

michael-valdron commented Sep 21, 2023

openshift-ci bot commented Sep 22, 2023

michael-valdron commented Sep 22, 2023

michael-valdron commented Sep 25, 2023

Add license header file and script #1256

Add license header file and script #1256

Conversation

michael-valdron commented Sep 18, 2023 • edited Loading

What does this PR do?

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

michael-valdron commented Sep 18, 2023

yangcao77 commented Sep 18, 2023

michael-valdron commented Sep 18, 2023

codecov bot commented Sep 18, 2023 • edited Loading

Codecov Report

michael-valdron commented Sep 18, 2023

michael-valdron commented Sep 18, 2023

maysunfaisal Sep 19, 2023

Choose a reason for hiding this comment

michael-valdron Sep 20, 2023

Choose a reason for hiding this comment

michael-valdron Sep 20, 2023

Choose a reason for hiding this comment

michael-valdron Sep 20, 2023

Choose a reason for hiding this comment

maysunfaisal Sep 21, 2023

Choose a reason for hiding this comment

michael-valdron Sep 21, 2023

Choose a reason for hiding this comment

michael-valdron commented Sep 21, 2023

michael-valdron commented Sep 21, 2023 • edited Loading

michael-valdron commented Sep 21, 2023

openshift-ci bot commented Sep 22, 2023

michael-valdron commented Sep 22, 2023

michael-valdron commented Sep 25, 2023

michael-valdron commented Sep 18, 2023 •

edited

Loading

codecov bot commented Sep 18, 2023 •

edited

Loading

michael-valdron commented Sep 21, 2023 •

edited

Loading