Dx: Add check for node version before yarn start (#108144)

* Dx: Add check for node version before yarn start

* .

* add IGNORE_NODE_VERSION_CHECK env var

* Update scripts/check-frontend-dev.sh

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* add check if nvmrc file exists

* fix lint

* codeowners

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Josh Hunt 2025-07-17 10:23:49 +01:00 committed by GitHub
parent 54d6140e6d
commit d4fc2399d0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 51 additions and 1 deletions

1
.github/CODEOWNERS vendored
View File

@ -627,6 +627,7 @@ playwright.storybook.config.ts @grafana/grafana-frontend-platform
/scripts/cli/ @grafana/grafana-frontend-platform /scripts/cli/ @grafana/grafana-frontend-platform
/scripts/clean-git-or-error.sh @grafana/grafana-as-code /scripts/clean-git-or-error.sh @grafana/grafana-as-code
/scripts/grafana-server/ @grafana/grafana-frontend-platform /scripts/grafana-server/ @grafana/grafana-frontend-platform
/scripts/check-frontend-dev.sh @grafana/grafana-frontend-platform
/scripts/helpers/ @grafana/grafana-developer-enablement-squad /scripts/helpers/ @grafana/grafana-developer-enablement-squad
/scripts/import_many_dashboards.sh @torkelo /scripts/import_many_dashboards.sh @torkelo
/scripts/mixin-check.sh @bergquist /scripts/mixin-check.sh @bergquist

View File

@ -6,6 +6,7 @@
"version": "12.1.0-pre", "version": "12.1.0-pre",
"repository": "github:grafana/grafana", "repository": "github:grafana/grafana",
"scripts": { "scripts": {
"predev": "./scripts/check-frontend-dev.sh",
"build": "NODE_ENV=production nx exec --verbose -- webpack --config scripts/webpack/webpack.prod.js", "build": "NODE_ENV=production nx exec --verbose -- webpack --config scripts/webpack/webpack.prod.js",
"build:nominify": "yarn run build -- --env noMinify=1", "build:nominify": "yarn run build -- --env noMinify=1",
"build:stats": "NODE_ENV=production webpack --progress --config scripts/webpack/webpack.stats.js", "build:stats": "NODE_ENV=production webpack --progress --config scripts/webpack/webpack.stats.js",
@ -46,7 +47,7 @@
"prettier:check": "prettier --check --ignore-path .prettierignore --list-different=false --log-level=warn \"**/*.{ts,tsx,scss,md,mdx,json,js,cjs}\"", "prettier:check": "prettier --check --ignore-path .prettierignore --list-different=false --log-level=warn \"**/*.{ts,tsx,scss,md,mdx,json,js,cjs}\"",
"prettier:checkDocs": "prettier --check --list-different=false --log-level=warn \"docs/**/*.md\" \"*.md\" \"packages/**/*.{ts,tsx,scss,md,mdx,json,js,cjs}\"", "prettier:checkDocs": "prettier --check --list-different=false --log-level=warn \"docs/**/*.md\" \"*.md\" \"packages/**/*.{ts,tsx,scss,md,mdx,json,js,cjs}\"",
"prettier:write": "prettier --ignore-path .prettierignore --list-different \"**/*.{js,ts,tsx,scss,md,mdx,json,cjs}\" --write", "prettier:write": "prettier --ignore-path .prettierignore --list-different \"**/*.{js,ts,tsx,scss,md,mdx,json,cjs}\" --write",
"start": "NODE_ENV=dev nx exec -- webpack --config scripts/webpack/webpack.dev.js --watch", "start": "yarn predev && NODE_ENV=dev nx exec -- webpack --config scripts/webpack/webpack.dev.js --watch",
"start:liveReload": "yarn start -- --env liveReload=1", "start:liveReload": "yarn start -- --env liveReload=1",
"start:noTsCheck": "yarn start -- --env noTsCheck=1", "start:noTsCheck": "yarn start -- --env noTsCheck=1",
"start:noLint": "yarn start -- --env noTsCheck=1 --env noLint=1", "start:noLint": "yarn start -- --env noTsCheck=1 --env noLint=1",

48
scripts/check-frontend-dev.sh Executable file
View File

@ -0,0 +1,48 @@
#!/usr/bin/env sh
# Exit early if running in CI environment
if [ -n "$CI" ] || [ -n "$GITHUB_ACTIONS" ] || [ -n "$IGNORE_NODE_VERSION_CHECK" ]; then
exit 0
fi
# Colors for prettier output
RED='\033[0;31m'
YELLOW='\033[1;33m'
GREEN='\033[0;32m'
BLUE='\033[0;34m'
CYAN='\033[0;36m'
NC='\033[0m' # No Color
BOLD='\033[1m'
# Check if .nvmrc file exists
if [ ! -f ".nvmrc" ]; then
printf "%b\n" ""
printf "%b\n" "${RED}⚠️ ERROR ⚠️${NC}"
printf "%b\n" "${YELLOW}${BOLD}.nvmrc file not found!${NC} Run '${BLUE}git checkout main -- .nvmrc${NC}' to fix."
printf "%b\n" ""
exit 1
fi
REQUIRED_VERSION=$(sed 's/v//' .nvmrc)
CURRENT_VERSION=$(node --version | sed 's/v//')
if [ "$CURRENT_VERSION" != "$REQUIRED_VERSION" ]; then
printf "%b\n" ""
printf "%b\n" "${RED}⚠️ WARNING ⚠️${NC}"
printf "%b\n" "${YELLOW}${BOLD}Node.js version mismatch!${NC}"
printf "%b\n" ""
printf "%b\n" "${BOLD}${CYAN}Recommended:${NC} ${GREEN}$REQUIRED_VERSION${NC} (from .nvmrc)"
printf "%b\n" "${BOLD}${CYAN}Current:${NC} ${RED}$CURRENT_VERSION${NC}"
printf "%b\n" ""
printf "%b\n" "${BOLD}${YELLOW}⚠️ We only test and support developing Grafana with the specific LTS Node.js release.${NC}"
printf "%b\n" " Using a different version may lead to unexpected build issues or runtime errors."
printf "%b\n" ""
printf "%b\n" "${BOLD}💡 Consider using a node version manager and configuring it to auto-switch to the recommended version:${NC}"
printf "%b\n" "${BLUE}nvm${NC} - Node Version Manager"
printf "%b\n" "${BLUE}fnm${NC} - Fast Node Manager"
printf "%b\n" ""
printf "%b\n" "${BLUE}${BOLD}If you experience issues building Grafana, first switch to the recommended version of Node.js.${NC}"
printf "%b\n" ""
fi