ATLAS-5293: ATLAS UI: Add repo-wide Git hooks and dashboard pre-commit/push verification

.githooks/pre-commit

@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+# Atlas monorepo: pre-commit (license, lint, typecheck, syntax; dashboard test guard)
+# Skip: SKIP_ATLAS_HOOKS=1 | SKIP_ALL_ATLAS_GIT_HOOKS=1
+set -e
+if [ "$SKIP_ATLAS_HOOKS" = "1" ] || [ "$SKIP_ALL_ATLAS_GIT_HOOKS" = "1" ]; then exit 0; fi
+ROOT="$(git rev-parse --show-toplevel)"
+exec node "$ROOT/scripts/git-hooks/run-precommit.mjs"

.githooks/pre-push

@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+# Atlas monorepo: pre-push (dashboard Jest/eslint/build; dashboardv2 + docs build)
+# Skip: SKIP_ATLAS_HOOKS=1 | SKIP_ALL_ATLAS_GIT_HOOKS=1
+set -e
+if [ "$SKIP_ATLAS_HOOKS" = "1" ] || [ "$SKIP_ALL_ATLAS_GIT_HOOKS" = "1" ]; then exit 0; fi
+ROOT="$(git rev-parse --show-toplevel)"
+exec node "$ROOT/scripts/git-hooks/run-prepush.mjs"

dashboard/.githooks/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+# Deprecated path: use repo root core.hooksPath=.githooks (see dashboard/scripts/install-git-hooks.mjs).
+ROOT="$(git rev-parse --show-toplevel)"
+exec "$ROOT/.githooks/pre-commit"

dashboard/.githooks/pre-push

@@ -0,0 +1,20 @@
+#!/usr/bin/env sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+ROOT="$(git rev-parse --show-toplevel)"
+exec "$ROOT/.githooks/pre-push"

dashboard/.husky/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+# Git hooks: core.hooksPath=.githooks at Atlas repo root (see dashboard npm prepare).
+printf '%s\n' '[atlas] Hooks: git config core.hooksPath .githooks  OR  npm install (in dashboard/)'
+exit 0

dashboard/docs/GIT_HOOKS.md

@@ -0,0 +1,127 @@
+# Atlas Git hooks (dashboard, dashboardv2, docs)
+
+Hooks run **locally** before `git commit` and `git push` so common issues are
+caught early. **CI** on the server is still required to enforce merges.
+
+## One-time setup (per clone)
+
+From the **Atlas repo root** (`atlas/`, where `.git` lives):
+
+```bash
+git config core.hooksPath .githooks
+```
+
+Or run **`npm install`** inside **`dashboard/`** — the **`prepare`** script runs
+`dashboard/scripts/install-git-hooks.mjs`, which sets **`core.hooksPath=.githooks`**
+when Git config is writable.
+
+Verify:
+
+```bash
+git config --get core.hooksPath
+# expect: .githooks
+```
+
+The active hook scripts live in **`.githooks/`** at the **repository root**.
+`dashboard/.githooks/*` only forwards to the root hooks (legacy path compat).
+
+## What runs when
+
+### `pre-commit` (root: `scripts/git-hooks/run-precommit.mjs`)
+
+Runs **only for packages that have staged paths** under that prefix.
+
+| Area | When staged under … | Checks |
+|------|---------------------|--------|
+| **dashboard** | `dashboard/` | (1) **UI test guard** — `src/views`, `src/components`, `App.tsx` / `Main.tsx` / `ErrorBoundary.tsx` must include a **staged** test file; (2) **RAT-aligned ASF license** on **new** files under `dashboard/src/` (`license-header-policy.mjs` markers, same bar as CI RAT); (3) **lint-staged** → ESLint on staged TS/TSX; (4) **`npm run typecheck`** (`tsc --noEmit`). |
+| **dashboardv2** | `dashboardv2/` | (1) **ASF license** on **new** `.js`/`.jsx`/`.ts`/`.tsx` (skips `node_modules`, `bin/`, `external_lib`, `.min.js`); (2) **`node --check`** on staged plain `.js` under `dashboardv2/public/js/` (syntax). **No** Jest/test guard (legacy Grunt UI). |
+| **docs** | `docs/` | (1) **ASF license** on **new** sources (skips `node_modules`, `site/`, `bin/`, `docz-lib/`); (2) **`node --check`** on staged **plain** `docs/**/*.js` outside theme/webapp JSX trees. |
+
+### `pre-push` (root: `scripts/git-hooks/run-prepush.mjs`)
+
+Runs for each package **if commits in the push range** touch that prefix.
+
+| Area | Checks |
+|------|--------|
+| **dashboard** | **RAT-aligned ASF header** on **new** `dashboard/src/` files in the push range, colocated tests on disk, **`jest --findRelatedTests`**, **`eslint src`**, **`npm run build`**. |
+| **dashboardv2** | **`npm run build`** (Grunt). |
+| **docs** | **`npm run build`** (Docz). |
+
+## Skip hooks (emergency / slow machines)
+
+Disable **everything**:
+
+```bash
+SKIP_ATLAS_HOOKS=1 git commit ...
+SKIP_ATLAS_HOOKS=1 git push ...
+```
+
+Per **package**:
+
+```bash
+SKIP_DASHBOARD_HOOKS=1 git commit ...
+SKIP_DASHBOARDV2_HOOKS=1 git commit ...
+SKIP_DOCS_HOOKS=1 git commit ...
+```
+
+**dashboard** only (still documented):
+
+```bash
+SKIP_DASHBOARD_TEST_GUARD=1 git commit ...   # staged test file rule
+SKIP_DASHBOARD_LICENSE_CHECK=1 git commit ... # RAT-aligned ASF on new dashboard/src (also used by pre-push added-file check)
+SKIP_DASHBOARD_TYPECHECK=1 git commit ...     # tsc on commit
+```
+
+**dashboardv2 / docs** ASF license on new files:
+
+```bash
+SKIP_ATLAS_LICENSE_CHECK=1 git commit ...
+```
+
+Skip **long builds** on push:
+
+```bash
+SKIP_DASHBOARDV2_BUILD=1 git push ...
+SKIP_DOCS_BUILD=1 git push ...
+```
+
+## Manual run (no Git hook)
+
+From **repo root** `atlas/`:
+
+```bash
+node scripts/git-hooks/run-precommit.mjs
+node scripts/git-hooks/run-prepush.mjs
+```
+
+**dashboard**-only local verify (same as before):
+
+```bash
+cd dashboard && npm run verify:precommit
+cd dashboard && npm run verify:prepush
+```
+
+## Limitations
+
+- **dashboardv2** has no ESLint in-repo; **`node --check`** only catches **syntax** on selected `.js` paths, not style.
+- **docs** JSX/theme files are not run through `node --check`.
+- Hooks can be bypassed with env vars; **rely on CI** for PR enforcement.
+
+## Files (reference)
+
+| Path | Role |
+|------|------|
+| `.githooks/pre-commit` | Root hook → `run-precommit.mjs` |
+| `.githooks/pre-push` | Root hook → `run-prepush.mjs` |
+| `scripts/git-hooks/run-precommit.mjs` | Monorepo pre-commit orchestration |
+| `scripts/git-hooks/run-prepush.mjs` | Monorepo pre-push orchestration |
+| `scripts/git-hooks/check-added-license-generic.mjs` | ASF header for v2/docs new files |
+| `scripts/git-hooks/syntax-check-staged.mjs` | `node --check` for v2/docs |
+| `scripts/git-hooks/lib/git-helpers.mjs` | `git diff` helpers |
+| `scripts/git-hooks/lib/extra-license-skip.mjs` | Path skip rules for v2/docs |
+| `dashboard/scripts/install-git-hooks.mjs` | Sets `core.hooksPath=.githooks` |
+| `dashboard/scripts/git-precommit-verify.mjs` | Dashboard staged UI ↔ test guard |
+| `dashboard/scripts/check-staged-new-file-license.mjs` | Dashboard ASF on new files |
+| `dashboard/scripts/git-prepush-verify.mjs` | Dashboard Jest, ESLint, build |
+| `dashboard/scripts/run-precommit-local.mjs` | `npm run verify:precommit` (dashboard only) |
+| `dashboard/lint-staged.config.mjs` | ESLint on staged dashboard sources |

dashboard/lint-staged.config.mjs

@@ -0,0 +1,31 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * 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.
+ */
+
+/**
+ * lint-staged config: Git reports paths as dashboard/src/... from repo root;
+ * ESLint runs with cwd = dashboard, so strip the dashboard/ prefix.
+ */
+
+export default {
+	'dashboard/src/**/*.{ts,tsx}': (filenames) => {
+		if (filenames.length === 0) {
+			return process.platform === 'win32' ? 'node -e "process.exit(0)"' : 'true'
+		}
+		const relative = filenames.map((f) => f.replace(/^dashboard\//, ''))
+		return `eslint --max-warnings 200 ${relative.join(' ')}`
+	},
+}

dashboard/scripts/check-push-new-file-license.mjs

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * 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.
+ */
+
+/**
+ * Pre-push: any *new* dashboard/src source files in the push range must carry
+ * a RAT-aligned Apache license header at HEAD (same policy as pre-commit).
+ *
+ * Skip: SKIP_DASHBOARD_HOOKS=1 | SKIP_DASHBOARD_LICENSE_CHECK=1
+ */
+
+import { execFileSync } from 'node:child_process'
+import { join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { getPushAddedRepoPaths } from './lib/git-changed-files.mjs'
+import {
+	gitShowUtf8,
+	listDashboardSrcAddedMissingLicense,
+} from './lib/verify-dashboard-src-license.mjs'
+
+if (
+	process.env.SKIP_DASHBOARD_HOOKS === '1' ||
+	process.env.SKIP_DASHBOARD_LICENSE_CHECK === '1' ||
+	process.env.HUSKY === '0'
+) {
+	process.exit(0)
+}
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url))
+const dashboardDir = join(__dirname, '..')
+
+let repoRoot
+try {
+	repoRoot = String(
+		execFileSync('git', ['rev-parse', '--show-toplevel'], {
+			encoding: 'utf8',
+			cwd: dashboardDir,
+		}),
+	).trim()
+} catch {
+	console.warn('[license-check push] Not in a Git work tree; skipping.')
+	process.exit(0)
+}
+
+const added = getPushAddedRepoPaths(repoRoot)
+const missing = listDashboardSrcAddedMissingLicense(
+	added,
+	(norm) => gitShowUtf8(repoRoot, `HEAD:${norm}`),
+)
+
+if (missing.length > 0) {
+	console.error(
+		'\x1b[31m[dashboard pre-push]\x1b[0m Added file(s) lack a RAT-aligned Apache license header:',
+	)
+	for (const m of missing.sort()) {
+		console.error(`  - ${m}`)
+	}
+	console.error(
+		'\nInclude the full standard ASF block at the top (see license-header-policy.mjs markers).',
+		'Or set SKIP_DASHBOARD_LICENSE_CHECK=1 only for rare exceptions.\n',
+	)
+	process.exit(1)
+}
+
+process.exit(0)