chore(make): make license to add licnese headers for all code files. (

#572) * make license Signed-off-by: seeflood <zhou.qunli@foxmail.com> * add doc Signed-off-by: seeflood <zhou.qunli@foxmail.com>
mosn · May 17, 2022 · b6466c2 · b6466c2
1 parent 289b7f1
commit b6466c2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -212,6 +212,14 @@ style.deadlink:
 style.quickstart:
 	@$(MAKE) checker.quickstart
 
+# ==============================================================================
+## license: Add license headers for code files.
+# ==============================================================================
+.PHONY: license
+license:
+	# For more details: https://github.com/apache/skywalking-eyes#docker-image
+	docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
+
 # ==============================================================================
 ## integrate.wasm: Run integration test with wasm.
 # ==============================================================================

diff --git a/docs/en/development/commands.md b/docs/en/development/commands.md
@@ -13,6 +13,8 @@ Layotto provides powerful commands, which makes contribution and local developme
 
 + Run `make build` to build layotto binary for host platform. 
 
++ Run `make license` to add licnese headers for all code files, with docker.
+
 See below commands to know more details or excute `make help`:
 
 ```
@@ -43,6 +45,7 @@ COMMANDS:
   style.coverage      Run coverage analysis.
   style.deadlink      Run deadlink check test.
   style.quickstart    Run quickstart check test.
+  license             Add license headers for code files.
   integrate.wasm      Run integration test with wasm.
   integrate.runtime   Run integration test with runtime.
   format              Format layotto go codes style with gofmt and goimports.

diff --git a/docs/zh/development/commands.md b/docs/zh/development/commands.md
@@ -16,6 +16,8 @@ Layotto 提供了丰富的命令行工具，方便贡献者开发和测试 Layot
 
 + 执行 `make build` 构建当前平台的二进制文件
 
++ 执行 `make license` 使用 docker 容器为代码文件添加 license headers
+
 具体细节可查看一下命令，或执行 `make help` 查看：
 
 ```
@@ -46,6 +48,7 @@ COMMANDS:
   style.coverage      Run coverage analysis.
   style.deadlink      Run deadlink check test.
   style.quickstart    Run quickstart check test.
+  license             Add license headers for code files.
   integrate.wasm      Run integration test with wasm.
   integrate.runtime   Run integration test with runtime.
   format              Format layotto go codes style with gofmt and goimports.