Script to automatically add licence headers #82

mariantalla · 2018-09-07T15:48:35Z

This PR adds a ensure-boilerplate.sh script; when run, it will add copyright/licence headers to applicable files.

Where a valid licence header is already present, the script will not update or otherwise change it. Similarly for files that it is configured to skip.

As discussed with sig-contributor-experience this is copied from pivotal-k8s/kubernetes-contrib-tools - we'll deprecate the latter once this PR is merged.

/cc @hoegaarden

hoegaarden · 2018-09-07T16:35:37Z

/cc @ixdy @mikedanese

nikhita · 2018-09-12T09:44:16Z

verify/boilerplate/boilerplate.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python

-# Copyright 2015 The Kubernetes Authors.
+# Copyright 2018 The Kubernetes Authors.


The year is not modified on updates. It reflects the year the file was added in.

Sorry ... this came from testing the boilerplate code on the boilerplate code itself [1] :) Will revert that.

nikhita · 2018-09-12T09:45:22Z

verify/boilerplate/boilerplate.py.txt

@@ -1,3 +1,5 @@
+#!/usr/bin/env python


nikhita · 2018-09-12T09:46:23Z

verify/verify-boilerplate.sh


-# Copyright 2014 The Kubernetes Authors.
+# Copyright 2018 The Kubernetes Authors.


should remain as 2014 only, since that is the year the file was created

nikhita · 2018-09-12T09:52:08Z

verify/boilerplate/boilerplate.py

+                        "pkg/generated/bindata.go"]
+
+# list all the files that contain 'DO NOT EDIT', but are not generated
+default_skipped_not_generated = ['hack/build-ui.sh', 'hack/lib/swagger.sh',


I might be wrong here but my understanding was that repo-infra is for all repositories under the kubernetes org and not just k/k. Wouldn't this hard core it to k/k only?

(I understand that this was present even before but just curious :))

As of now, we are not sure where repo-infra is actually used. We'd like to see it being used everywhere, also in k/k.

As we started off using the script from k/k we kept the defaults as they were in the k/k repo. However, we introduced an option to override those via a config file in other repos. An example of a config file can be found on this PR for this repo here.

Maybe we can add more (clearer) docs about exactly that. There is some documentation about that here.

Another related question is: Where should this config file be located. Right now we expect it to be in ${REPO_ROOT}/boilerplate.json. If you think that is a too prominent location, we are happy to switch to e.g. ${REPO_ROOT}/.boilerplate.json or something else -- just let us know.

+1 to .boilerplate.json instead of boilerplate.json.

and also I agree with @nikhita that having k/k defaults here seems weird.

We will remove the k/k defaults and come up with a set of defaults that are reasonable for a broad range of repos

We will switch to using .boilerplate.json for the config file

nikhita · 2018-09-12T09:55:54Z

verify/boilerplate/boilerplate.generatego.txt

@@ -0,0 +1,16 @@
+/*
+Copyright The Kubernetes Authors.


nikhita · 2018-09-12T10:02:13Z

To follow the same conventions as scripts in hack/, can we rename this to update-boilerplate.sh instead of ensure-boilerplate.sh?

Also, I am a little confused about how repo-infra is being used for k/k right now. k/k has it's own boilerplate verification: https://github.com/kubernetes/kubernetes/blob/master/hack/verify-boilerplate.sh and https://github.com/kubernetes/kubernetes/tree/master/hack/boilerplate.

/cc @cblecker @spiffxp

hoegaarden · 2018-09-12T11:08:07Z

As said, we are not sure where repo-infra is used and where it is not. The boilerplate stuff is different between in k/k and in repo-infra (before our change). That might be, because it has not been updated in a while or because k/k never had used repo-infra. But ideally, at least from our point of view, k/k should use repo-infra and should have some mechanism to automatically update to new versions of repo-infra.
We went for ensure-boilerplate.sh instead of update-boilerplate.sh because it does not really update anything if the boilerplate is already there, it only adds the boilerplate on files which do not have it. Having said that, if you think update-boilerplate.sh is a better name we are happy to rename the thing.

nikhita · 2018-09-12T11:54:46Z

We went for ensure-boilerplate,sh instead of update-boilerplate.sh because it does not really update anything if the boilerplate is already there, it only adds the boilerplate on files which do not have it. Having said that, if you think update-boilerplate.sh is a better name we are happy to rename the thing.

No strong opinions. ensure-boilerplate sgtm.

I'm not aware of the history between repo-infra and k/k. I'll defer to @ixdy @spiffxp @cblecker on that one.

…stead. Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>

hoegaarden · 2018-10-03T12:53:23Z

Hello @nikhita @ixdy @spiffxp @cblecker .

Do you have any input on that? We'd like to move that forward and see if we can even use that in k/k. Any thoughts?

cblecker · 2018-10-03T17:05:44Z

I like the idea, but python isn't my area of expertise.

WDTY @ixdy @spiffxp? Maybe we could rope @fejta into helping review if you're good with the idea :)

tao12345666333 · 2018-10-05T02:38:34Z

verify/boilerplate/boilerplate.py

+        with open(conf_path) as json_data_file:
+            return json.load(json_data_file)
+    except ValueError:
+        raise


nikhita · 2018-10-30T17:18:12Z

cc @justaugustus @dims @swinslow

This relates to our licensing efforts in Kubernetes.

hoegaarden · 2018-12-10T05:53:33Z

Is there anything we can do to get this merged?

Or even more importantly: is there a way to track which repos actually use this repo and therefore assess if it's even relevant?

nikhita · 2018-12-10T17:39:18Z

is there a way to track which repos actually use this repo and therefore assess if it's even relevant?

I believe the verify script for license headers is not used anywhere currently. k/k has its own verify script but the plan is to start using this repo in the future.

ixdy · 2019-01-09T00:14:33Z

As said, we are not sure where repo-infra is used and where it is not. The boilerplate stuff is different between in k/k and in repo-infra (before our change). That might be, because it has not been updated in a while or because k/k never had used repo-infra. But ideally, at least from our point of view, k/k should use repo-infra and should have some mechanism to automatically update to new versions of repo-infra.

Right, I don't have a good answer for how we can easily vendor scripts from repo-infra and keep them up to date; just copying the scripts from repo-infra into the various other repos is not great. Anyone have any good suggestions?

hoegaarden · 2019-01-09T12:43:34Z

What if this repo had a script which would update itself via git subtree merge that could be called from within the parent repo (k/k for example).

I'd be up for experimenting with that in kubernetes-sigs/testing_frameworks.

spiffxp · 2019-03-05T16:52:14Z

... automation should really be removing the needs-rebase label automatically on push

fejta · 2019-03-29T02:07:09Z

/lifecycle stale

Any chance you're going to come back to this? It looks cool and super useful!

hoegaarden · 2019-03-29T09:30:44Z

@fejta I think all the issues and comments are addressed. So I think it is done from our perspective.

fejta · 2019-03-29T20:31:10Z

Cool! Meaning you're waiting on a review?

/remove-lifecycle stale

hoegaarden · 2019-03-30T13:19:34Z

Yes, that'd be great.

nikhita · 2019-04-28T14:30:46Z

Bumping this. Looks like this needs more reviewers (I'm way out of touch with python)

nikhita · 2019-06-07T05:59:39Z

Can we merge and iterate here?

We require donated repos to have this boilerplate header for all their files. Adding the header to each file in a repo is extremely cumbersome, this script would be immensely helpful in such cases.

fejta-bot · 2019-09-05T06:15:37Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

nikhita · 2019-09-05T06:16:24Z

/remove-lifecycle stale

fejta-bot · 2019-12-04T06:24:44Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

fejta-bot · 2020-01-03T07:10:05Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

k8s-ci-robot · 2020-01-03T07:10:13Z

@mariantalla: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

fejta-bot · 2020-02-02T07:53:12Z

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

k8s-ci-robot · 2020-02-02T07:53:19Z

@fejta-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot requested a review from hoegaarden September 7, 2018 15:48

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 7, 2018

hoegaarden added 2 commits September 7, 2018 17:20

Add ensure-boilerplate.sh

f45d491

Add travis test for ensure & verify boilerplate scripts

1e021db

mariantalla changed the title ~~WIP - Script to automatically add licence headers~~ Script to automatically add licence headers Sep 7, 2018

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 7, 2018

k8s-ci-robot requested review from ixdy and mikedanese September 7, 2018 16:35

hoegaarden mentioned this pull request Sep 12, 2018

Provide an update-boilerplate script kubernetes/kubernetes#65183

Open

nikhita reviewed Sep 12, 2018

View reviewed changes

k8s-ci-robot requested review from cblecker and spiffxp September 12, 2018 10:02

Revert copyright year changes

498244e

hoegaarden mentioned this pull request Sep 16, 2018

fix broken links pivotal-k8s/kubernetes-contrib-tools#1

Merged

fix broken links and according PEP8 == None should use is None in…

b34ffa1

…stead. Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>

mariantalla mentioned this pull request Sep 18, 2018

REQUEST: New membership for mariantalla kubernetes/org#93

Closed

6 tasks

tao12345666333 reviewed Oct 5, 2018

View reviewed changes

spiffxp removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 5, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 29, 2019

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 29, 2019

This was referenced Jun 2, 2019

Request to create new bare repository kubernetes-sigs/nodus on behalf of sig-scheduling kubernetes/org#839

Closed

Change placeholder by machine-controller kubermatic/machine-controller#563

Closed

This was referenced Jun 7, 2019

migrate osbkit/minibroker to kubernetes-sigs/minibroker kubernetes/org#894

Closed

Migrate pmorie/go-open-service-broker-client to kubernetes-sigs/go-open-service-broker-client kubernetes/org#893

Closed

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2019

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 4, 2019

k8s-ci-robot closed this Feb 2, 2020

nikhita mentioned this pull request Mar 6, 2023

Provide a way to automatically add license headers kubernetes/org#4073

Open

Priyankasaggu11929 mentioned this pull request Sep 25, 2023

Adding automation to add boilerplate license/copyrights headers kubernetes/org#4077

Closed


		# Copyright 2014 The Kubernetes Authors.
		# Copyright 2018 The Kubernetes Authors.

Script to automatically add licence headers #82

Script to automatically add licence headers #82

Conversation

mariantalla commented Sep 7, 2018 • edited Loading

hoegaarden commented Sep 7, 2018

Choose a reason for hiding this comment

hoegaarden Sep 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoegaarden Sep 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nikhita commented Sep 12, 2018

hoegaarden commented Sep 12, 2018 • edited Loading

nikhita commented Sep 12, 2018

hoegaarden commented Oct 3, 2018

cblecker commented Oct 3, 2018

tao12345666333 Oct 5, 2018 • edited Loading

Choose a reason for hiding this comment

nikhita commented Oct 30, 2018

hoegaarden commented Dec 10, 2018 • edited Loading

nikhita commented Dec 10, 2018

ixdy commented Jan 9, 2019

hoegaarden commented Jan 9, 2019 • edited Loading

spiffxp commented Mar 5, 2019

fejta commented Mar 29, 2019

hoegaarden commented Mar 29, 2019

fejta commented Mar 29, 2019

hoegaarden commented Mar 30, 2019

nikhita commented Apr 28, 2019

nikhita commented Jun 7, 2019

fejta-bot commented Sep 5, 2019

nikhita commented Sep 5, 2019

fejta-bot commented Dec 4, 2019

fejta-bot commented Jan 3, 2020

k8s-ci-robot commented Jan 3, 2020

fejta-bot commented Feb 2, 2020

k8s-ci-robot commented Feb 2, 2020

mariantalla commented Sep 7, 2018 •

edited

Loading

hoegaarden Sep 12, 2018 •

edited

Loading

hoegaarden Sep 12, 2018 •

edited

Loading

hoegaarden commented Sep 12, 2018 •

edited

Loading

tao12345666333 Oct 5, 2018 •

edited

Loading

hoegaarden commented Dec 10, 2018 •

edited

Loading

hoegaarden commented Jan 9, 2019 •

edited

Loading