Automate docs and license generation

.github/workflows/cli-build_test.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 # This workflow will build a golang project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
 

.github/workflows/go-lint.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 name: golangci-lint
 on:
   push:

.github/workflows/service-build_test.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 # This workflow will build a golang project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
 

.github/workflows/tag-release.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 name: Tag
 
 on:

.github/workflows/update-docs-and-licenses.yml

@@ -0,0 +1,36 @@
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+name: 'Auto-Update Docs & Licenses'
+
+permissions:
+  contents: write
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+  push:
+    branches:
+      - main
+
+jobs:
+  update-files:
+    # skip runs triggered by the bot's own commit to avoid loops
+    if: github.actor != 'github-actions[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          # on push to main, use main; on PR, check out the PR head
+          ref: ${{ github.event.pull_request.head.ref || github.ref }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update docs & licenses
+        run: |
+          ./hack/update-docs-and-licenses.sh
+
+      - name: Commit and push changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: "auto(docs): update docs and licenses"

hack/update-docs-and-licenses.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+# Copyright (c) Codesphere Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+set -euo pipefail
+IFS=$'\n\t'
+
+here=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+root=$(cd "$here/.." && pwd)
+
+echo "Working directory: $root"
+
+cd "$root"
+
+echo "1/2: Generating docs"
+
+if command -v go >/dev/null 2>&1; then
+    go run ./hack/gendocs/main.go
+    echo "Docs generated into: $root/docs"
+else
+    echo "ERROR: 'go' binary not found in PATH. Install Go and retry." >&2
+    exit 2
+fi
+
+echo "2/2: Updating licenses"
+
+echo "Checking license tooling: go-licenses + addlicense"
+
+export GOBIN="$(go env GOBIN 2>/dev/null || echo "$HOME/go/bin")"
+export PATH="$GOBIN:$PATH"
+
+need_install=()
+if ! command -v go-licenses >/dev/null 2>&1; then
+    need_install+=("github.com/google/go-licenses@latest")
+fi
+if ! command -v addlicense >/dev/null 2>&1; then
+    need_install+=("github.com/google/addlicense@latest")
+fi
+
+if [ ${#need_install[@]} -ne 0 ]; then
+    echo "Installing missing tools: ${need_install[*]}"
+    for pkg in "${need_install[@]}"; do
+        if command -v go >/dev/null 2>&1; then
+            go install "$pkg"
+        else
+            echo "ERROR: 'go' binary not found; cannot install $pkg" >&2
+            exit 2
+        fi
+    done
+fi
+
+echo "Generating NOTICE via go-licenses"
+if command -v go-licenses >/dev/null 2>&1; then
+
+    if ! go-licenses report --template .NOTICE.template ./... > NOTICE 2> >(grep -v "module .* has empty version, defaults to HEAD" >&2); then
+        echo "go-licenses report failed" >&2
+    fi
+    echo "NOTICE generated/updated"
+else
+    echo "go-licenses not available; skipping NOTICE generation" >&2
+fi
+
+echo "Done."

internal/portal/api_key.go

@@ -1,3 +1,6 @@
+// Copyright (c) Codesphere Inc.
+// SPDX-License-Identifier: Apache-2.0
+
 package portal
 
 import "time"

internal/util/required_flag.go

@@ -1,3 +1,6 @@
+// Copyright (c) Codesphere Inc.
+// SPDX-License-Identifier: Apache-2.0
+
 package util
 
 import (