tt-studio v1 Release

.github/workflows/backend-license-checker.yml

@@ -0,0 +1,101 @@
+name: Check SPDX Licenses
+
+on:
+  workflow_dispatch:
+  workflow_call:
+  pull_request:
+    branches:
+      - "main"
+      - "staging"
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - assigned
+      - review_requested
+
+jobs:
+  check-spdx-licenses:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/[email protected]
+        with:
+          cache: "pip"
+          python-version: "3.8"
+      - name: Install copyright check tool
+        run: pip install git+https://github.com/espressif/check-copyright.git@master
+      - name: Check SPDX licenses
+        id: check_spdx_licenses
+        run: |
+          set +e
+          output=$(python -m check_copyright --verbose --dry-run --config ./check_copyright_config.yaml . 2>&1)
+          exit_code=$?
+          clean_output=$(echo "$output" | sed 's/\x1b\[[0-9;]*m//g')
+          echo "CLEAN_OUTPUT<<EOF" >> $GITHUB_ENV
+          echo "$clean_output" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "EXIT_CODE=$exit_code" >> $GITHUB_ENV
+          exit 0
+      - name: Debug Extracted Files
+        run: |
+          echo "Extracted Files:"
+          echo "$CLEAN_OUTPUT"
+      - name: Extract Files
+        id: extract_files
+        run: |
+            set +e
+            files=$(echo "$CLEAN_OUTPUT" | awk '
+              /Files which failed the copyright check:/, /Additional information about this hook and copyright headers may be found here:/ {
+                if ($0 !~ /Files which failed the copyright check:/ && $0 !~ /Additional information about this hook and copyright headers may be found here:/) print
+              }
+              /Some files are without a copyright note and a license header needs to be added:/, /Additional information about this hook and copyright headers may be found here:/ {
+                if ($0 !~ /Some files are without a copyright note and a license header needs to be added:/ && $0 !~ /Additional information about this hook and copyright headers may be found here:/) print
+              }' | sed 's/^ *//' | sed '/^$/d' | grep '^.')
+            echo "FILES<<EOF" >> $GITHUB_ENV
+            echo "$files" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+            echo "Extracted Files: $files"
+            exit 0
+      - name: Debug Extracted Files   
+        run: |
+          echo "Extracted Files:"
+          echo "$FILES"
+
+      # Extract and clean file paths
+      - name: Extract File Paths
+        if: env.FILES != ''
+        run: |
+            # Extract lines starting with './' but ignore any paths following "Modified files:" until a stop marker
+            files_clean=$(echo "$FILES" | awk '/^Modified files:/ {ignore = 1} /^Above is a list of files/ {ignore = 0} !ignore && /^\.\// {print}' | sort | uniq)
+            # Save the cleaned files into a new environment variable 'FILES_CLEAN'
+            echo "FILES_CLEAN<<EOF" >> $GITHUB_ENV
+            echo "$files_clean" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+            echo "Extracted Paths: $files_clean"       
+      - name: Debug Extracted Paths
+        run: |
+            echo "Extracted Paths:"
+            echo "$FILES_CLEAN"
+            echo "---------------------------------"
+      - name: Comment on PR or Issue
+        if: env.FILES_CLEAN != ''
+        uses: actions/github-script@v7
+        with:
+              script: |
+                const formattedOutput = process.env.FILES_CLEAN;
+                const issueNumber = context.issue.number || context.payload.pull_request.number;
+                const owner = context.repo.owner;
+                const repo = context.repo.repo;
+                if (formattedOutput) {
+                  const commentBody = `Our automated SPDX license verification process has discovered that the following files are missing a license header:\n\`\`\`\n${formattedOutput}\n\`\`\`\nPlease ensure each indicated file includes a valid SPDX license identifier. This is essential for maintaining licensing compliance. Your attention and cooperation in updating these files are greatly appreciated. Thank you.`;
+                  await github.rest.issues.createComment({
+                    issue_number: issueNumber,
+                    owner: owner,
+                    repo: repo,
+                    body: commentBody
+                  });
+                  core.setFailed("SPDX license issues found.");
+                } else {
+                  console.log("No SPDX license issues found.");
+                }

.github/workflows/frontend-lint-license-checker.yml

@@ -0,0 +1,148 @@
+name: Front-End Linter SPDX Licenses Checker
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "main"
+      - "staging"
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - assigned
+      - review_requested
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        working-directory: app/frontend  
+        run: npm install
+
+      - name: Run ESLint with Auto-fix
+        working-directory: app/frontend
+        run: |
+          set +e
+          npm run lint || true  # Run lint and allow the workflow to continue even if there are warnings/errors
+
+      # Run ESLint and Capture Output
+      - name: Run ESLint and Capture Output
+        working-directory: app/frontend  
+        id: run_eslint
+        run: |
+          set +e
+          output=$(npm run lint --silent 2>&1)
+          exit_code=$?
+          echo "$output"
+          clean_output=$(echo "$output" | sed 's/\x1b\[[0-9;]*m//g')  # Remove ANSI escape codes
+          echo "CLEAN_OUTPUT<<EOF" >> $GITHUB_ENV
+          echo "$clean_output" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+          grouped_errors=""
+          current_file=""
+          errors_for_file=""
+          has_errors=false
+          missing_lc_headers=false
+          lc_flagged_files=""
+
+          while IFS= read -r line; do
+            if echo "$line" | grep -q '^\s*\/'; then
+              if [ "$has_errors" = true ]; then
+                grouped_errors+="$current_file\n$errors_for_file\n------------------------------------------------------------------------------------------------------------------------------------------\n"
+                errors_for_file=""
+                has_errors=false
+              fi
+              current_file=$(echo "$line" | sed 's/\n//g')
+            elif echo "$line" | grep -q 'error'; then
+              errors_for_file+="  $line\n"
+              has_errors=true
+
+              if echo "$line" | grep -q 'missing header'; then
+                missing_lc_headers=true
+                errors_for_file+="!Flagged: LC header missing\n"
+                lc_flagged_files+="${current_file}\n"
+              fi
+            fi
+          done <<< "$clean_output"
+
+          if [ "$has_errors" = true ]; then
+            grouped_errors+="$current_file\n$errors_for_file\n"
+          fi
+
+          if [ -n "$grouped_errors" ]; then
+            echo "Errors found."
+            echo "GROUPED_ERRORS<<EOF" >> $GITHUB_ENV
+            echo -e "$grouped_errors" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+            echo "HAS_ERRORS=true" >> $GITHUB_ENV
+          else
+            echo "No relevant errors found."
+            echo "HAS_ERRORS=false" >> $GITHUB_ENV
+          fi
+
+          if [ "$missing_lc_headers" = true ]; then
+            echo "LC headers missing in one or more files."
+            echo "MISSING_LC_HEADERS=true" >> $GITHUB_ENV
+            echo "LC_FLAGGED_FILES<<EOF" >> $GITHUB_ENV
+            echo -e "$(echo -e "$lc_flagged_files" | sed '/^\s*$/d')" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+          else
+            echo "MISSING_LC_HEADERS=false" >> $GITHUB_ENV
+          fi
+
+          exit 0
+
+      # Comment on PR with ESLint Errors and LC Headers
+      - name: Comment on PR with ESLint Errors and LC Headers
+        if: env.MISSING_LC_HEADERS == 'true'  # Ensure we only comment if there are missing license headers
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const lintErrors = process.env.GROUPED_ERRORS;
+            const issueNumber = context.payload.pull_request.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+
+            let commentBody = "";
+
+            if (process.env.MISSING_LC_HEADERS === 'true') {
+              const flaggedFiles = process.env.LC_FLAGGED_FILES.trim();
+              commentBody += `## 🚨 SPDX-License Header Errors\n\nThe following files are missing the required license headers:\n\n\`\`\`\n${flaggedFiles}\n\`\`\`\nPlease ensure each of these files includes a valid SPDX license identifier to maintain licensing compliance.`;
+            }
+
+            if (lintErrors && process.env.MISSING_LC_HEADERS === 'true') {
+              commentBody += `\n\n## Frontend Project: ESLint Errors\n\`\`\`\n${lintErrors}\n\`\`\`\nPlease review and resolve the ESLint errors.`;
+            }
+
+            if (commentBody.trim() && issueNumber) {
+              await github.rest.issues.createComment({
+                issue_number: issueNumber,
+                owner: owner,
+                repo: repo,
+                body: commentBody
+              });
+            } else {
+              console.log("No relevant errors to report.");
+            }
+
+      - name: Fail the Workflow if LC Headers Are Missing
+        if: env.MISSING_LC_HEADERS == 'true'
+        run: |
+          echo "Failing the workflow because LC headers are missing."
+          exit 1

.gitignore

@@ -7,6 +7,7 @@
 __pycache__
 *egg-info
 *.whl
+.venv/
 
 # Virtual Environment
 env
@@ -37,3 +38,6 @@ db.sqlite3
 
 # unignore
 !requirements.txt
+!app/frontend/third-party-licenses.txt
+!requirements-dev.txt
+

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.7.0
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

FAQ.md

@@ -0,0 +1,41 @@
+# Frequently Asked Questions
+
+## Table of Contents 
+1. [Frontend Does Not Load](#frontend-does-not-load)
+2. [Module not found](#module-not-found-error)
+
+## Frontend Does Not Load 
+
+If the frontend app has not loaded despite running `docker compose up --build`, there is likely an issue with docker using cached files. Check if the `node_modules` directory has been created in `tt-studio/app/frontend`. If this directory is missing, this usually means that `npm (Node Package Manager)` did not successfully run and docker has skipped running this since it used layer caching. To resolve run the following: 
+
+```bash
+docker compose build --no-cache
+docker compose up
+```
+
+## Module not found error
+
+This error often occurs due to missing or corrupted dependencies. Here's a quick fix:
+
+1. Delete `node_modules` and `package-lock.json`:
+
+
+```shellscript
+rm -rf node_modules package-lock.json
+```
+
+2. Reinstall dependencies:
+
+
+```shellscript
+cd frontend
+npm i
+```
+
+3. Re-run App using docker:
+
+
+```shellscript
+docker compose down
+docker compose up --build
+```