Merge pull request #23 from SAP/spdx-license-headers

add command line option to generate license headers in spdx format

Author: cbarbian-sap

scaffold/scaffold.go

@@ -28,6 +28,7 @@ import (
 
 type Config struct {
 	Owner                          string `json:"owner,omitempty"`
+	SpdxLicenseHeader              bool   `json:"spdxLicenseHeader"`
 	GroupName                      string `json:"groupName,omitempty"`
 	GroupVersion                   string `json:"groupVersion,omitempty"`
 	Kind                           string `json:"kind,omitempty"`
@@ -97,6 +98,7 @@ func main() {
 
 	pflag.BoolVar(&showVersion, "version", false, "Show version")
 	pflag.StringVar(&config.Owner, "owner", "SAP SE", "Owner of this project, as written to the license header")
+	pflag.BoolVar(&config.SpdxLicenseHeader, "spdx-license-header", false, "Whether to write license headers in SPDX format")
 	pflag.StringVar(&config.GroupName, "group-name", "operator.kyma-project.io", "API group name")
 	pflag.StringVar(&config.GroupVersion, "group-version", "v1alpha1", "API group version")
 	pflag.StringVar(&config.Kind, "kind", "", "API kind for the component")

scaffold/templates/hack/boilerplate.go.txt.tpl

@@ -1,3 +1,9 @@
+{{- if .spdxLicenseHeader -}}
+/*
+SPDX-FileCopyrightText: {{ now.Year }} {{ .owner }}
+SPDX-License-Identifier: Apache-2.0
+*/
+{{ else -}}
 /*
 Copyright {{ now.Year }} {{ .owner }}.
 
@@ -12,4 +18,5 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-*/
+*/
+{{ end -}}

website/content/en/docs/usage/scaffolder.md

@@ -30,6 +30,7 @@ Usage: scaffold [options] [output directory]
       --version                                    Show version
       --owner string                               Owner of this project, as written to the license header
                                                    (default "SAP SE")
+      --spdx-license-header                        Whether to write license headers in SPDX format
       --group-name string                          API group name (default "operator.kyma-project.io")
       --group-version string                       API group version (default "v1alpha1")
       --kind string                                API kind for the component