From 2ef30955e56ffc8511938efd3deba1f561ca2d1e Mon Sep 17 00:00:00 2001 From: Stefan Bobrowski Date: Sat, 24 May 2025 13:15:52 -0500 Subject: [PATCH] update readme, add github actions --- .github/workflows/pr-check.yml | 30 ++++++++++++++++++++++++++++++ README.md | 7 +++++++ 2 files changed, 37 insertions(+) create mode 100644 .github/workflows/pr-check.yml diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml new file mode 100644 index 0000000..8bd3bef --- /dev/null +++ b/.github/workflows/pr-check.yml @@ -0,0 +1,30 @@ +name: PR Check (Lint & Build) + +on: + pull_request: + branches: + - main + +jobs: + validate: + name: Validate PR (lint + build) + runs-on: ubuntu-latest + + steps: + - name: Checkout PR code + uses: actions/checkout@v3 + + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + node-version: 20 + cache: 'npm' + + - name: Install dependencies + run: npm ci + + - name: Lint code + run: npm run lint + + - name: Build project + run: npm run build diff --git a/README.md b/README.md index c2869bb..46d58dc 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Built with: 7. ✅ **Example Component** with SCSS modules and hooks 8. ✅ **VS Code integration** (`.vscode/settings.json`, `.editorconfig`) 9. ✅ **ESLint + Prettier** pre-configured for modern standards +10. ✅ **GitHub Actions PR Validation** – Automatically lints and builds on pull requests targeting `main` 🔧 Nothing super opinionated. Just fast, clean, and extensible. @@ -38,6 +39,12 @@ Created by [@stefanbobrowski](https://github.com/stefanbobrowski) --- +## 🧷 GitHub Code + +[GitHub – vite-react-ts-starter](https://github.com/stefanbobrowski/vite-react-ts-starter) + +--- + ## 📄 License Licensed under the **Apache License 2.0**.