ch_checker: Add copyright check for yml files

All source files need to have copyright header based on Eclipse
Foundation handbook and yml files are source files for GitHub
Actions and Workflows. Addition to adding copyright header to
each yml file, the cr_checker will also now check their existance
in every new yml file that is added into repository.

Issue-ref: resolves #6

.github/actions/gitlint/action.yml

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 name: "Gitlint Action"
 description: "An action to install and run Gitlint on PR commits"
 inputs:

.github/workflows/copyright.yml

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 name: Copyright checks
 on:
   pull_request:

.github/workflows/docs.yml

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 name: Documentation build
 on:
   pull_request:

.github/workflows/format.yml

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 name: Formatting checks
 on:
   pull_request:

.github/workflows/gitlint.yml

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 name: Gitlint check
 on:
   pull_request:

BUILD

@@ -34,8 +34,9 @@ alias(
 filegroup(
     name = "repo_directories",
     srcs = [
+        ".github",
         "docs",
-        "tools",
+        "tools/format",
     ],
     visibility = [
         "//tools/cr_checker:__subpackages__",

MODULE.bazel

@@ -1,3 +1,16 @@
+# *******************************************************************************
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
 module(
     name = "score_platform",
     version = "0.1",

tools/cr_checker/BUILD

@@ -20,7 +20,6 @@ check(
         "//:MODULE.bazel",
         "//:repo_directories",
     ],
-    offset = 24,
     visibility = ["//visibility:public"],
 )
 

tools/cr_checker/cr_checker.bzl

@@ -38,7 +38,7 @@ def _cr_impl(ctx):
 
     ctx.actions.write(
         output = ctx.outputs.executable,
-        content = "{tool}.py -t {template} {extensions} {fix} {use_mmap} {debug} {log_file} {offset} {srcs}".format(
+        content = "{tool} -t {template} {extensions} {fix} {use_mmap} {debug} {log_file} {offset} {srcs}".format(
             tool = script.files_to_run.executable.short_path,
             template = ctx.file.template.path,
             extensions = text_exts,
@@ -72,6 +72,8 @@ _cr_rule = rule(
         "use_memory_map": attr.bool(mandatory = False, default = False),
         "_script": attr.label(
             default = Label("//tools/cr_checker/tool:cr_checker"),
+            executable = True,
+            cfg = "exec",
         ),
     },
 )

tools/cr_checker/resources/templates.ini

@@ -25,7 +25,7 @@
 * SPDX-License-Identifier: Apache-2.0
 ********************************************************************************/
 
-[py,sh,bzl,ini,BUILD]
+[py,sh,bzl,ini,yml,BUILD,bazel]
 # *******************************************************************************
 # Copyright (c) 2024 Contributors to the Eclipse Foundation
 #
@@ -53,4 +53,3 @@
    #
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
-

tools/cr_checker/tool/cr_checker.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # *******************************************************************************
 # Copyright (c) 2024 Contributors to the Eclipse Foundation
 #
@@ -536,16 +534,24 @@ def main(argv=None):
     LOGGER.info("Process completed.")
     LOGGER.info(
         "Total files without copyright: %s%d%s",
-        COLORS["GREEN"],
+        COLORS["RED"] if total_no > 0 else COLORS["GREEN"],
         total_no,
         COLORS["ENDC"],
     )
-    LOGGER.info(
-        "Total files that were fixed: %s%d%s",
-        COLORS["RED"] if total_fixes > 0 else COLORS["GREEN"],
-        total_fixes,
-        COLORS["ENDC"],
-    )
+    if args.fix:
+        total_not_fixed = total_no - total_fixes
+        LOGGER.info(
+            "Total files that were fixed: %s%d%s",
+            COLORS["GREEN"],
+            total_fixes,
+            COLORS["ENDC"],
+        )
+        LOGGER.info(
+            "Total files that were NOT fixed: %s%d%s",
+            COLORS["RED"] if total_not_fixed > 0 else COLORS["GREEN"],
+            total_not_fixed,
+            COLORS["ENDC"],
+        )
     LOGGER.info("=" * 64)
 
     return 0 if total_no == 0 else 1