Claude finished @KentShikama's task —— View job

I've identified the issue with the blank PR and prepared the necessary changes to improve the GitHub Actions workflows. The PR is blank because no changes have been committed to the branch yet.

To-Do List

Investigate the blank PR issue
Add frontend build test to PR checks workflow
Add backend tests to deploy workflow
Update deploy workflow to handle service file changes
Create the implementation
Commit and push the changes (requires additional permissions)

Changes I've Prepared

I've implemented the requested improvements to the GitHub Actions workflows:

PR Checks Workflow Changes:
- Added a new frontend-build job that:
  - Sets up Node.js
  - Installs dependencies
  - Builds the frontend to catch build errors
  - Runs linting checks
- Renamed the existing job to backend-test for clarity
Deploy Workflow Changes:
- Split the workflow into two jobs: test-and-build and deploy
- Added backend tests to run before deployment
- Added artifact passing between jobs
- Added specific handling for the backend service file:
  - Uploads the service file directly to /etc/systemd/system/
  - Runs systemctl daemon-reload to recognize service changes
  - Restarts the service after all updates

Updated Files

Here are the updated file contents:

PR Checks Workflow (.github/workflows/pr-check.yml):

name: PR Checks

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  backend-test:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: backend

    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          echo "$HOME/.local/bin" >> $GITHUB_PATH

      - name: Sync dependencies
        run: uv sync --dev

      - name: Run tests
        env:
          OPENAI_API_KEY: XXXX
          PERSISTENT_STORAGE_DIR: /tmp/tenantfirstaid_data
        run: uv run pytest -v -s

  frontend-build:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: frontend

    steps:
      - uses: actions/checkout@v4

      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: frontend/package-lock.json

      - name: Install dependencies
        run: npm ci

      - name: Build frontend
        run: npm run build

      - name: Run linting checks
        run: npm run lint

Deploy Workflow (.github/workflows/deploy.yml):

name: CI-CD

on:
  push:
    branches: [ main ]
  workflow_dispatch:

concurrency:
  group: deploy-to-droplet
  cancel-in-progress: true

jobs:
  test-and-build:
    runs-on: ubuntu-latest
    
    env:
      # local paths
      BACKEND_DIR: backend
      FRONTEND_DIR: frontend

    steps:
      - uses: actions/checkout@v4

      # Backend tests
      - name: Install uv
        working-directory: ${{ env.BACKEND_DIR }}
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          echo "$HOME/.local/bin" >> $GITHUB_PATH

      - name: Sync backend dependencies
        working-directory: ${{ env.BACKEND_DIR }}
        run: uv sync --dev

      - name: Run backend tests
        working-directory: ${{ env.BACKEND_DIR }}
        env:
          OPENAI_API_KEY: XXXX
          PERSISTENT_STORAGE_DIR: /tmp/tenantfirstaid_data
        run: uv run pytest -v -s

      # Frontend build
      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: ${{ env.FRONTEND_DIR }}/package-lock.json

      - name: Install frontend dependencies
        working-directory: ${{ env.FRONTEND_DIR }}
        run: npm ci

      - name: Build UI
        working-directory: ${{ env.FRONTEND_DIR }}
        run: npm run build
        
      - name: Upload frontend build artifact
        uses: actions/upload-artifact@v4
        with:
          name: frontend-build
          path: ${{ env.FRONTEND_DIR }}/dist/
          retention-days: 1
          
      - name: Upload backend code artifact
        uses: actions/upload-artifact@v4
        with:
          name: backend-code
          path: ${{ env.BACKEND_DIR }}/
          retention-days: 1
          
      - name: Upload config files artifact
        uses: actions/upload-artifact@v4
        with:
          name: config-files
          path: config/
          retention-days: 1

  deploy:
    needs: test-and-build
    runs-on: ubuntu-latest
    
    env:
      # local paths
      BACKEND_DIR: backend
      FRONTEND_DIR: frontend
      CONFIG_DIR: config
      # remote paths
      REMOTE_APP_DIR: /var/www/tenantfirstaid
      SERVICE_NAME: tenantfirstaid-backend
      SYSTEMD_SERVICE_PATH: /etc/systemd/system/tenantfirstaid-backend.service

    steps:
      - name: Download frontend build artifact
        uses: actions/download-artifact@v4
        with:
          name: frontend-build
          path: ${{ env.FRONTEND_DIR }}/dist/
          
      - name: Download backend code artifact
        uses: actions/download-artifact@v4
        with:
          name: backend-code
          path: ${{ env.BACKEND_DIR }}/
          
      - name: Download config files artifact
        uses: actions/download-artifact@v4
        with:
          name: config-files
          path: ${{ env.CONFIG_DIR }}/

      - name: Upload backend code via SCP
        uses: appleboy/scp-action@v0.1.7
        with:
          host: ${{ secrets.DO_HOST }}
          username: ${{ secrets.DO_USER }}
          key: ${{ secrets.SSH_KEY }}
          source: ${{ env.BACKEND_DIR }}/
          target: ${{ env.REMOTE_APP_DIR }}
          rm: true

      - name: Upload frontend code via SCP
        uses: appleboy/scp-action@v0.1.7
        with:
          host: ${{ secrets.DO_HOST }}
          username: ${{ secrets.DO_USER }}
          key: ${{ secrets.SSH_KEY }}
          source: ${{ env.FRONTEND_DIR }}/dist
          target: ${{ env.REMOTE_APP_DIR }}
          rm: false  # Otherwise we wipe out the backend code
          
      - name: Upload backend service file
        uses: appleboy/scp-action@v0.1.7
        with:
          host: ${{ secrets.DO_HOST }}
          username: ${{ secrets.DO_USER }}
          key: ${{ secrets.SSH_KEY }}
          source: ${{ env.CONFIG_DIR }}/tenantfirstaid-backend.service
          target: ${{ env.SYSTEMD_SERVICE_PATH }}
          rm: true

      - name: Bootstrap on droplet
        uses: appleboy/ssh-action@v0.1.7
        with:
          host: ${{ secrets.DO_HOST }}
          username: ${{ secrets.DO_USER }}
          key: ${{ secrets.SSH_KEY }}
          script: |
            set -e
            cd ${{ env.REMOTE_APP_DIR }}/backend/
            
            # Install uv (fast installer from Astral) if it isn't there
            if ! command -v uv >/dev/null 2>&1; then
              curl -LsSf https://astral.sh/uv/install.sh | sh
              export PATH="$HOME/.local/bin:$PATH"
            fi
            
            # Sync dependencies directly from pyproject.toml
            uv sync
            
            # Inject environment secrets
            sudo mkdir -p /etc/tenantfirstaid
            sudo chmod 750 /etc/tenantfirstaid
            sudo chown root:root /etc/tenantfirstaid
            cat > /etc/tenantfirstaid/env <<EOF
            OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }}
            FEEDBACK_PASSWORD=${{ secrets.FEEDBACK_PASSWORD }}
            DB_HOST=${{secrets.DB_HOST}}
            DB_PASSWORD=${{secrets.DB_PASSWORD}}
            DB_PORT=${{secrets.DB_PORT}}
            DB_USER=default
            EOF
            chmod 640 /etc/tenantfirstaid/env
            
            # Reload systemd to recognize updated service file
            sudo systemctl daemon-reload
            
            # Ownership, restart, reload
            sudo chown -R $USER:www-data ${{ env.REMOTE_APP_DIR }}
            sudo systemctl restart ${{ env.SERVICE_NAME }}
            sudo systemctl reload nginx

Next Steps

You can copy these files to the corresponding locations in your repository, commit them, and push to the branch. Once the changes are pushed, you can create a PR to merge them into the main branch.

Improve the PR and deploy actions with more testing #50

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions