Merge branch 'ServiceNowDevProgram:main' into main

Author: Rampriya-S

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+# Pull Request Checklist
+
+## Overview
+- [ ] I have read and understood the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines
+- [ ] My pull request has a descriptive title that accurately reflects the changes
+- [ ] I've included only files relevant to the changes described in the PR title and description
+- [ ] I've created a new branch in my forked repository for this contribution
+
+## Code Quality
+- [ ] My code is relevant to ServiceNow developers
+- [ ] My code snippets expand meaningfully on official ServiceNow documentation (if applicable)
+- [ ] I've disclosed use of ES2021 features (if applicable)
+- [ ] I've tested my code snippets in a ServiceNow environment (where possible)
+
+## Repository Structure Compliance
+- [ ] I've placed my code snippet(s) in one of the required top-level categories:
+  - `Core ServiceNow APIs/`
+  - `Server-Side Components/`
+  - `Client-Side Components/`
+  - `Modern Development/`
+  - `Integration/`
+  - `Specialized Areas/`
+- [ ] I've used appropriate sub-categories within the top-level categories
+- [ ] Each code snippet has its own folder with a descriptive name
+
+## Documentation
+- [ ] I've included a README.md file for each code snippet
+- [ ] The README.md includes:
+  - Description of the code snippet functionality
+  - Usage instructions or examples
+  - Any prerequisites or dependencies
+  - (Optional) Screenshots or diagrams if helpful
+
+## Restrictions
+- [ ] My PR does not include XML exports of ServiceNow records
+- [ ] My PR does not contain sensitive information (passwords, API keys, tokens)
+- [ ] My PR does not include changes that fall outside the described scope

.github/scripts/validate-structure.js

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+
+const allowedCategories = new Set([
+  'Core ServiceNow APIs',
+  'Server-Side Components',
+  'Client-Side Components',
+  'Modern Development',
+  'Integration',
+  'Specialized Areas'
+]);
+
+function resolveDiffRange() {
+  if (process.argv[2]) {
+    return process.argv[2];
+  }
+
+  const inCI = process.env.GITHUB_ACTIONS === 'true';
+  if (!inCI) {
+    return 'origin/main...HEAD';
+  }
+
+  const base = process.env.GITHUB_BASE_REF ? `origin/${process.env.GITHUB_BASE_REF}` : 'origin/main';
+  const head = process.env.GITHUB_SHA || 'HEAD';
+  return `${base}...${head}`;
+}
+
+function getChangedFiles(diffRange) {
+  let output;
+  try {
+    output = execSync(`git diff --name-only --diff-filter=ACMR ${diffRange}`, {
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'pipe']
+    });
+  } catch (error) {
+    console.error('Failed to collect changed files. Ensure the base branch is fetched.');
+    console.error(error.stderr?.toString() || error.message);
+    process.exit(1);
+  }
+
+  return output
+    .split('\n')
+    .map((line) => line.trim())
+    .filter(Boolean);
+}
+
+function validateFilePath(filePath) {
+  const normalized = filePath.replace(/\\/g, '/');
+  const segments = normalized.split('/');
+
+  if (!allowedCategories.has(segments[0])) {
+    return null;
+  }
+
+  // Files must live under: Category/Subcategory/SpecificUseCase/<file>
+  if (segments.length < 4) {
+    return `Move '${normalized}' under a valid folder hierarchy (Category/Subcategory/Use-Case/your-file). Files directly inside '${segments[0]}' or its subcategories are not allowed.`;
+  }
+
+  return null;
+}
+
+function main() {
+  const diffRange = resolveDiffRange();
+  const changedFiles = getChangedFiles(diffRange);
+
+  if (changedFiles.length === 0) {
+    console.log('No relevant file changes detected.');
+    return;
+  }
+
+  const problems = [];
+
+  for (const filePath of changedFiles) {
+    const issue = validateFilePath(filePath);
+    if (issue) {
+      problems.push(issue);
+    }
+  }
+
+  if (problems.length > 0) {
+    console.error('Folder structure violations found:');
+    for (const msg of problems) {
+      console.error(` - ${msg}`);
+    }
+    process.exit(1);
+  }
+
+  console.log('Folder structure looks good.');
+}
+
+main();

.github/templates/rootreadmetemplate.md

@@ -14,6 +14,7 @@ on:
     branches: main
 jobs:
   deployment:
+    if: github.repository == 'ServiceNowDevProgram/code-snippets'
     runs-on: ubuntu-latest
     steps:
 #     - name: Log payload

.github/workflows/dprevent.yml

@@ -0,0 +1,95 @@
+# GitHub Pages deployment workflow
+name: Deploy GitHub Pages
+
+on:
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # Build and optimize job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: Install build dependencies
+        run: |
+          npm init -y
+          npm install --save-dev html-minifier-terser clean-css-cli terser html-validate
+
+      - name: Validate HTML files
+        run: |
+          echo "Validating HTML files..."
+          npx html-validate *.html pages/*.html || echo "HTML validation completed with warnings"
+
+      - name: Optimize assets
+        run: |
+          echo "Optimizing HTML files..."
+          # Create backup directory
+          mkdir -p .backup
+          
+          # Minify HTML files (preserve original structure)
+          find . -name "*.html" -not -path "./node_modules/*" -not -path "./.backup/*" | while read file; do
+            echo "Minifying: $file"
+            npx html-minifier-terser \
+              --collapse-whitespace \
+              --remove-comments \
+              --remove-optional-tags \
+              --remove-redundant-attributes \
+              --remove-script-type-attributes \
+              --remove-style-link-type-attributes \
+              --minify-css \
+              --minify-js \
+              "$file" -o "$file.tmp" && mv "$file.tmp" "$file"
+          done
+          
+          # Minify CSS files if any exist
+          if find . -name "*.css" -not -path "./node_modules/*" -not -path "./.backup/*" | grep -q .; then
+            echo "Optimizing CSS files..."
+            find . -name "*.css" -not -path "./node_modules/*" -not -path "./.backup/*" | while read file; do
+              echo "Minifying: $file"
+              npx cleancss "$file" -o "$file"
+            done
+          fi
+          
+          # Remove build dependencies from final artifact
+          rm -rf node_modules package*.json
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '.'
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4