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

Add missing license headers to source files #1673

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

ShyamsundarR
Copy link
Member

Discovered while attempting to revive goheader linter.

The linter itself seems to have some issues, but as that is being worked on, adding the license to the flagged off files by the linter.

Discovered while attempting to revive goheader linter.

The linter itself seems to have some issues, but as that is being
worked on, adding the license to the flagged off files by the linter.

Signed-off-by: Shyamsundar Ranganathan <[email protected]>
@ShyamsundarR
Copy link
Member Author

e2e failure is flake as in #1659

Copy link
Member

@nirs nirs left a comment

Choose a reason for hiding this comment

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

We can to revive the reuse lint:

% reuse lint
/Users/nir/.venv/ramen/lib/python3.13/site-packages/reuse/project.py:329: PendingDeprecationWarning: '.reuse/dep5' is deprecated. You are recommended to instead use REUSE.toml. Use `reuse convert-dep5` to convert.
  warnings.warn(
# MISSING COPYRIGHT AND LICENSING INFORMATION

The following files have no copyright and licensing information:
* .dockerignore
* .flake8
* .gitignore
* .vimrc.example
* api/go.mod
* api/go.sum
* config/certmanager/certificate.yaml
* config/certmanager/kustomization.yaml
* config/certmanager/kustomizeconfig.yaml
* config/crd/bases/_.yaml
* config/crd/bases/ramendr.openshift.io_drclusterconfigs.yaml
* config/crd/bases/ramendr.openshift.io_drclusters.yaml
* config/crd/bases/ramendr.openshift.io_drplacementcontrols.yaml
* config/crd/bases/ramendr.openshift.io_drpolicies.yaml
* config/crd/bases/ramendr.openshift.io_maintenancemodes.yaml
* config/crd/bases/ramendr.openshift.io_protectedvolumereplicationgrouplists.yaml
* config/crd/bases/ramendr.openshift.io_replicationgroupdestinations.yaml
* config/crd/bases/ramendr.openshift.io_replicationgroupsources.yaml
* config/crd/bases/ramendr.openshift.io_volumereplicationgroups.yaml
* config/crd/kustomization.yaml
* config/crd/kustomizeconfig.yaml
* config/default/manager_auth_proxy_patch.yaml
* config/default/manager_config_patch.yaml
* config/dr-cluster/crd/kustomization.yaml
* config/dr-cluster/default/kustomization.yaml
* config/dr-cluster/manager/kustomization.yaml
* config/dr-cluster/manager/ramen_manager_config.yaml
* config/dr-cluster/manifests/bases/ramen_dr_cluster.clusterserviceversion.yaml
* config/dr-cluster/manifests/ramen/kustomization.yaml
* config/dr-cluster/rbac/kustomization.yaml
* config/dr-cluster/rbac/role.yaml
* config/dr-cluster/rbac/role_binding.yaml
* config/dr-cluster/samples/kustomization.yaml
* config/hub/crd/kustomization.yaml
* config/hub/default/k8s/kustomization.yaml
* config/hub/default/k8s/metrics_role_binding.yaml
* config/hub/default/ocp/kustomization.yaml
* config/hub/default/ocp/metrics_role_binding.yaml
* config/hub/manager/kustomization.yaml
* config/hub/manager/ramen_manager_config.yaml
* config/hub/manifests/bases/ramen_hub.clusterserviceversion.yaml
* config/hub/manifests/ramen/kustomization.yaml
* config/hub/manifests/ramen/ramen_manager_config_append.yaml
* config/hub/rbac/kustomization.yaml
* config/hub/rbac/role.yaml
* config/hub/rbac/role_binding.yaml
* config/hub/samples/kustomization.yaml
* config/manager/manager.yaml
* config/olm-install/base/catalog-source-kustomizeconfig.yaml
* config/olm-install/base/kustomization.yaml
* config/olm-install/base/ramen-catalog.yaml
* config/olm-install/base/ramen-operator-group.yaml
* config/olm-install/dr-cluster/kustomization.yaml
* config/olm-install/dr-cluster/ramen-dr-cluster-subscription.yaml
* config/olm-install/hub/kustomization.yaml
* config/olm-install/hub/ramen-hub-subscription.yaml
* config/prometheus/alerts.yaml
* config/prometheus/kustomization.yaml
* config/prometheus/monitor.yaml
* config/rbac/auth_proxy_client_clusterrole.yaml
* config/rbac/auth_proxy_role.yaml
* config/rbac/auth_proxy_role_binding.yaml
* config/rbac/auth_proxy_service.yaml
* config/rbac/drcluster_editor_role.yaml
* config/rbac/drcluster_viewer_role.yaml
* config/rbac/drclusterconfig_editor_role.yaml
* config/rbac/drclusterconfig_viewer_role.yaml
* config/rbac/drplacementcontrol_editor_role.yaml
* config/rbac/drplacementcontrol_viewer_role.yaml
* config/rbac/drpolicy_editor_role.yaml
* config/rbac/drpolicy_viewer_role.yaml
* config/rbac/leader_election_role.yaml
* config/rbac/leader_election_role_binding.yaml
* config/rbac/maintenancemode_editor_role.yaml
* config/rbac/maintenancemode_viewer_role.yaml
* config/rbac/metrics_role.yaml
* config/rbac/protectedvolumereplicationgrouplist_editor_role.yaml
* config/rbac/protectedvolumereplicationgrouplist_viewer_role.yaml
* config/rbac/role.yaml
* config/rbac/role_binding.yaml
* config/rbac/service_account.yaml
* config/rbac/volumereplicationgroup_editor_role.yaml
* config/rbac/volumereplicationgroup_viewer_role.yaml
* config/samples/kustomization.yaml
* config/samples/ramendr_v1alpha1_drcluster.yaml
* config/samples/ramendr_v1alpha1_drclusterconfig.yaml
* config/samples/ramendr_v1alpha1_drplacementcontrol.yaml
* config/samples/ramendr_v1alpha1_drpolicy.yaml
* config/samples/ramendr_v1alpha1_maintenancemode.yaml
* config/samples/ramendr_v1alpha1_metrodr_drcluster.yaml
* config/samples/ramendr_v1alpha1_metrodr_drpolicy.yaml
* config/samples/ramendr_v1alpha1_protectedvolumereplicationgrouplist.yaml
* config/samples/ramendr_v1alpha1_ramenconfig.yaml
* config/samples/ramendr_v1alpha1_volumereplicationgroup.yaml
* config/scorecard/bases/config.yaml
* config/scorecard/kustomization.yaml
* config/scorecard/patches/basic.config.yaml
* config/scorecard/patches/olm.config.yaml
* coverage.pth
* docs/design/Cephfs-RDR-ConsistencyGroup.md
* docs/dev/cve.md
* docs/diagrams/cephfs-cg-rdr-enable.drawio.svg
* docs/diagrams/cephfs-cg-rdr-failover.drawio.svg
* docs/diagrams/cephfs-cg-rdr-relocate.drawio.svg
* docs/diagrams/cephfs-cg-sm.drawio.svg
* docs/diagrams/cephfs-init-deployment.drawio.html
* docs/diagrams/cephfs-init-deployment.drawio.svg
* docs/diagrams/cephfs-rdr-enable.drawio.html
* docs/diagrams/cephfs-rdr-enable.drawio.svg
* docs/diagrams/cephfs-rdr-failover.drawio.html
* docs/diagrams/cephfs-rdr-failover.drawio.svg
* docs/diagrams/cephfs-rdr-relocate.drawio.html
* docs/diagrams/cephfs-rdr-relocate.drawio.svg
* docs/logging.md
* e2e/config.yaml
* e2e/go.mod
* e2e/go.sum
* e2e.yaml
* examples/dr_cluster_config.yaml
* examples/dr_hub_config.yaml
* examples/managedclusterview/mcv-pv.yaml
* examples/managedclusterview/mcv-vrg.yaml
* go.mod
* go.sum
* hack/check-drenv-prereqs.sh
* hack/commit-msg
* hack/dev-env.sh
* hack/fakes/fake_volume_group_source_handler.go
* hack/install-controller-gen.sh
* hack/install-golangci-lint.sh
* hack/install-kustomize.sh
* hack/install-operator-sdk.sh
* hack/install-opm.sh
* hack/install-setup-envtest.sh
* hack/make-venv
* hack/test/0000_00_clusters.open-cluster-management.io_managedclusters.crd.yaml
* hack/test/0000_00_work.open-cluster-management.io_manifestworks.crd.yaml
* hack/test/0000_01_addon.open-cluster-management.io_managedclusteraddons.crd.yaml
* hack/test/0000_02_clusters.open-cluster-management.io_clusterclaims.crd.yaml
* hack/test/0000_02_clusters.open-cluster-management.io_placements.crd.yaml
* hack/test/0000_03_clusters.open-cluster-management.io_placementdecisions.crd.yaml
* hack/test/applicationset-crd.yaml
* hack/test/apps.open-cluster-management.io_placementrules_crd.yaml
* hack/test/groupsnapshot.storage.k8s.io_volumegroupsnapshotclasses.yaml
* hack/test/groupsnapshot.storage.k8s.io_volumegroupsnapshots.yaml
* hack/test/policy.open-cluster-management.io_placementbindings.yaml
* hack/test/policy.open-cluster-management.io_policies.yaml
* hack/test/recipes.ramendr.openshift.io.yaml
* hack/test/replication.storage.openshift.io_volumereplicationclasses.yaml
* hack/test/replication.storage.openshift.io_volumereplications.yaml
* hack/test/snapshot.storage.k8s.io_volumesnapshotclasses.yaml
* hack/test/snapshot.storage.k8s.io_volumesnapshots.yaml
* hack/test/velero.io_backups.yaml
* hack/test/velero.io_backupstoragelocations.yaml
* hack/test/velero.io_restores.yaml
* hack/test/view.open-cluster-management.io_managedclusterviews.yaml
* hack/test/volsync.backube_replicationdestinations.yaml
* hack/test/volsync.backube_replicationsources.yaml
* internal/controller/cel/cel_drclusters_test.go
* internal/controller/cel/cel_drplacementcontrol_test.go
* internal/controller/cel/cel_drpolicy_test.go
* internal/controller/cephfscg/cephfscg_suite_test.go
* internal/controller/cephfscg/cghandler.go
* internal/controller/cephfscg/cghandler_test.go
* internal/controller/cephfscg/replicationgroupdestination.go
* internal/controller/cephfscg/replicationgroupdestination_test.go
* internal/controller/cephfscg/replicationgroupsource.go
* internal/controller/cephfscg/replicationgroupsource_test.go
* internal/controller/cephfscg/utils.go
* internal/controller/cephfscg/volumegroupsourcehandler.go
* internal/controller/cephfscg/volumegroupsourcehandler_test.go
* internal/controller/util/cephfs_cg.go
* internal/controller/util/cephfs_cg_test.go
* internal/controller/util/json_util.go
* internal/controller/util/json_util_test.go
* ramenctl/MANIFEST.in
* ramenctl/README.md
* requirements.txt
* test/.coveragerc
* test/addons/external-snapshotter/controller/kustomization.yaml
* test/addons/external-snapshotter/crds/kustomization.yaml
* test/addons/rbd-mirror/README.md
* test/addons/velero/credentials.conf
* test/etc_sudoers.d_lima
* test/gitlap/README.md
* test/gitlap/gitlap.conf
* test/kubeconfig.tmp
* test/lima-list.json
* test/pytest.ini
* test/python-version.diff
* test/registry/README.md
* test/registry/host.minikube.internal.conf
* test/registry/systemd/registry.container
* test/registry/systemd/registry.volume
* test/scripts/drenv-selftest
* test/scripts/network.xml
* test/scripts/refresh-cache
* test/scripts/refresh-cache.crontab
* test/scripts/setup-libvirt
* test/scripts/watch-replication
* test/stress-test/README.md
* test/vms/cirros/README.md
* test/vms/cirros/meta-data
* test/vms/cirros/user-data

The following files have no licensing information:
* DCO
* hack/test/multicluster.x-k8s.io_serviceexports.yaml

# SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: 0
* Unused licenses: 0
* Used licenses: Apache-2.0
* Read errors: 0
* Files with copyright information: 380 / 584
* Files with license information: 378 / 584

Unfortunately, your project is not compliant with version 3.3 of the REUSE Specification :-(


# RECOMMENDATIONS

* Fix missing copyright/licensing information: For one or more files, the tool
  cannot find copyright and/or licensing information. You typically do this by
  adding 'SPDX-FileCopyrightText' and 'SPDX-License-Identifier' tags to each
  file. The tutorial explains additional ways to do this:
  <https://reuse.software/tutorial/>

@ShyamsundarR
Copy link
Member Author

@nirs thanks for the list, the one go file in that list seems to be generated by counterfeiter which needs an issue by itself to understand what license the file should carry.

Other go files that were missing the license are covered in this PR (which was the intent here).

Fixing the linter, or using a different linter is a separate concern from this PR as I want to address the missing license sooner.

@ShyamsundarR ShyamsundarR merged commit 6f4bd6b into RamenDR:main Nov 26, 2024
21 of 22 checks passed
@ShyamsundarR ShyamsundarR deleted the linter-2 branch November 26, 2024 00:28
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.

2 participants