[skywalking-eyes] branch main updated: Add copyright-year configuration (#145)

[ke...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-eyes.git


The following commit(s) were added to refs/heads/main by this push:
     new 8fc52ba  Add copyright-year configuration (#145)
8fc52ba is described below

commit 8fc52baabc14c86294d96034bcc194cfa7f76b05
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Tue Jan 10 13:19:24 2023 +0800

    Add copyright-year configuration (#145)
---
 README.md            | 2 ++
 pkg/header/config.go | 8 ++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 82615b1..e0724d3 100644
--- a/README.md
+++ b/README.md
@@ -595,6 +595,7 @@ header: # <1>
   license:
     spdx-id: Apache-2.0 # <2>
     copyright-owner: Apache Software Foundation # <3>
+    copyright-year: '1993-2022' # <25>
     software-name: skywalking-eyes # <4>
     content: | # <5>
       Licensed to Apache Software Foundation (ASF) under one or more contributor
@@ -707,6 +708,7 @@ header:
 22. The minimum percentage of the file that must contain license text for identifying a license, default is `75`.
 23. The dependencies that should be excluded when analyzing the licenses, this is useful when you declare the dependencies in `pom.xml` with `compile` scope but don't distribute them in package. (Note that non-`compile` scope dependencies are automatically excluded so you don't need to put them here).
 24. The transitive dependencies brought by <23> should be recursively excluded when analyzing the licenses, currently only maven project supports this.
+25. The copyright year of the work, if it's empty, it will be set to the current year. If you don't want to update the license year anually, you can set this to the year of the first publication of your work, such as `1994`, or `1994-2023`.
 
 **NOTE**: When the `SPDX-ID` is Apache-2.0 and the owner is Apache Software foundation, the content would be [a dedicated license](https://www.apache.org/legal/src-headers.html#headers) specified by the ASF, otherwise, the license would be [the standard one](https://www.apache.org/foundation/license-faq.html#Apply-My-Software).
 
diff --git a/pkg/header/config.go b/pkg/header/config.go
index f698fb8..f7bc0fa 100644
--- a/pkg/header/config.go
+++ b/pkg/header/config.go
@@ -46,6 +46,7 @@ var (
 type LicenseConfig struct {
 	SpdxID         string `yaml:"spdx-id"`
 	CopyrightOwner string `yaml:"copyright-owner"`
+	CopyrightYear  string `yaml:"copyright-year"`
 	SoftwareName   string `yaml:"software-name"`
 	Content        string `yaml:"content"`
 	Pattern        string `yaml:"pattern"`
@@ -172,10 +173,13 @@ func (config *ConfigHeader) Finalize() error {
 }
 
 func (config *ConfigHeader) GetLicenseContent() (c string) {
-	owner, name := config.License.CopyrightOwner, config.License.SoftwareName
+	owner, name, year := config.License.CopyrightOwner, config.License.SoftwareName, config.License.CopyrightYear
+	if year == "" {
+		year = strconv.Itoa(time.Now().Year())
+	}
 
 	defer func() {
-		c = strings.ReplaceAll(c, "[year]", strconv.Itoa(time.Now().Year()))
+		c = strings.ReplaceAll(c, "[year]", year)
 		c = strings.ReplaceAll(c, "[owner]", owner)
 		c = strings.ReplaceAll(c, "[software-name]", name)
 	}()