action.yml

name: 'Deploy Course to qBraid'
description: 'Validate, upload, and deploy a course to qBraid platform'
author: 'qBraid'
branding:
  icon: 'upload-cloud'
  color: 'blue'

inputs:
  api-key:
    description: 'qBraid API key (pass from secrets, e.g. secrets.QBRAID_API_KEY)'
    required: true
  repo-read-token:
    description: 'GitHub token with read access (pass from secrets, e.g. secrets.GITHUB_TOKEN)'
    required: true
  course-json-path:
    description: 'Path to course.json file'
    required: false
    default: 'course.json'
  article-type:
    description: 'Type of article (course or blog)'
    required: false
    default: 'course'
  force-duplicate-questions:
    description: 'Whether to force duplicate questions'
    required: false
    default: 'false'
  draft:
    description: 'Whether to create a draft course (true or false)'
    required: false
    default: 'false'
  max-poll-attempts:
    description: 'Maximum polling attempts before timing out'
    required: false
    default: '20'
  poll-interval-seconds:
    description: 'Seconds to wait between polling attempts'
    required: false
    default: '15'
  max-consecutive-errors:
    description: 'Maximum consecutive polling errors before failing'
    required: false
    default: '5'
  mode:
    description: 'Operation mode: "create" or "update"'
    required: false
    default: 'create'
  course-custom-id:
    description: 'Custom ID of the course (required if mode is "update")'
    required: false

outputs:
  course_name:
    description: 'Name of the deployed course'
    value: ${{ steps.validate-course.outputs.course_name }}
  course-custom-id:
    description: 'Custom ID of the deployed course'
    value: ${{ steps.create-course.outputs.course_custom_id }}${{ steps.update-course.outputs.course_custom_id }}
  qbook_url:
    description: 'URL of the deployed course'
    value: ${{ steps.poll-status.outputs.qbook_url }}

runs:
  using: "composite"
  steps:
    - name: Install UV
      uses: astral-sh/setup-uv@v4
      with:
        version: "latest"

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'

    - name: Install dependencies
      shell: bash
      run: |
        uv pip install --system -e ${{ github.action_path }}

    - name: Validate required secrets (passed as inputs)
      shell: bash
      run: |
        if [[ -z "${{ inputs.api-key }}" ]]; then
          echo "::error::api-key is empty. In your workflow, pass it from secrets (e.g. secrets.QBRAID_API_KEY)."
          exit 1
        fi
        if [[ -z "${{ inputs.repo-read-token }}" ]]; then
          echo "::error::repo-read-token is empty. In your workflow, pass it from secrets (e.g. secrets.GITHUB_TOKEN)."
          exit 1
        fi

    - name: Stage 1 - Validate course.json structure
      id: validate-course
      shell: bash
      run: |
        python ${{ github.action_path }}/src/scripts/validate_course.py "${{ inputs.course-json-path }}"

    - name: Stage 2 - Verify all notebooks exist
      shell: bash
      run: |
        python ${{ github.action_path }}/src/scripts/verify_notebooks.py

    - name: Stage 3 - Verify all image references in notebooks
      shell: bash
      run: |
        python ${{ github.action_path }}/src/scripts/check_images.py

    - name: Stage 5a - Create Course
      if: inputs.mode == 'create'
      id: create-course
      shell: bash
      run: |
        python ${{ github.action_path }}/src/scripts/create_course.py \
          --api-key '${{ inputs.api-key }}' \
          --repo-read-token '${{ inputs.repo-read-token }}' \
          --repo-url '${{ github.server_url }}/${{ github.repository }}' \
          --commit-sha '${{ github.sha }}' \
          --article-type '${{ inputs.article-type }}' \
          --force-duplicate-questions '${{ inputs.force-duplicate-questions }}'

    - name: Stage 5b - Update Course
      if: inputs.mode == 'update'
      id: update-course
      shell: bash
      run: |
        python ${{ github.action_path }}/src/scripts/update_course.py \
          --api-key '${{ inputs.api-key }}' \
          --course-custom-id '${{ inputs.course-custom-id }}' \
          --repo-read-token '${{ inputs.repo-read-token }}' \
          --repo-url '${{ github.server_url }}/${{ github.repository }}' \
          --commit-sha '${{ github.sha }}' \
          --article-type '${{ inputs.article-type }}' \
          --force-duplicate-questions '${{ inputs.force-duplicate-questions }}'

    - name: Stage 6 - Poll status end point for completion
      id: poll-status
      shell: bash
      env:
        QBRAID_MAX_POLL_ATTEMPTS: ${{ inputs.max-poll-attempts }}
        QBRAID_POLL_INTERVAL_SECONDS: ${{ inputs.poll-interval-seconds }}
        QBRAID_MAX_CONSECUTIVE_ERRORS: ${{ inputs.max-consecutive-errors }}
      run: |
        COURSE_ID="${{ steps.create-course.outputs.course_custom_id }}${{ steps.update-course.outputs.course_custom_id }}"
        if [[ -z "$COURSE_ID" ]]; then
          echo "::error::course_custom_id output is empty after create/update step. This usually means the API response shape changed or did not include article.customId."
          exit 1
        fi
        python ${{ github.action_path }}/src/scripts/poll_files_progress.py '${{ inputs.api-key }}' "$COURSE_ID"

    - name: Create deployment summary
      if: success()
      shell: bash
      run: |
        cat >> $GITHUB_STEP_SUMMARY << 'DELIMITER'
        # 🎉 Course Deployment Successful
        
        Your course has been successfully deployed to qBraid!
        
        **Course Name:** ${{ steps.validate-course.outputs.course_name }}
        **Course Custom ID:** ${{ steps.create-course.outputs.course_custom_id }}${{ steps.update-course.outputs.course_custom_id }}
        **qBook URL:** ${{ steps.poll-status.outputs.qbook_url }}
        
        ## Next Steps
        
        You can now access your course at the qBook URL above.
        
        DELIMITER

    - name: Send notification comment
      if: success()
      uses: actions/github-script@v7
      with:
        script: |
          try {
            await github.rest.repos.createCommitComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              commit_sha: context.sha,
              body: `🎓 **Course Deployment Complete!**\n\nYour course is now live on qBraid.\n\n**View your course:** ${{ steps.poll-status.outputs.qbook_url }}\n\nCourse name: \`${{ steps.validate-course.outputs.course_name }}\`\n\nCourse Custom ID: \`${{ steps.create-course.outputs.course_custom_id }}${{ steps.update-course.outputs.course_custom_id }}\``
            });
          } catch (error) {
            if (error.status === 403) {
              core.warning('Could not create commit comment due to missing permissions. Please ensure the workflow has "contents: write" permission or "Read and write permissions" are enabled in repository settings.');
            } else {
              core.warning(`Failed to send notification: ${error.message}`);
            }
          }

    - name: Send failure notification
      if: failure()
      uses: actions/github-script@v7
      with:
        script: |
          try {
            await github.rest.repos.createCommitComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              commit_sha: context.sha,
              body: `❌ **Course Deployment Failed**\n\nThe deployment to qBraid failed. Please check the logs for more details.`
            });
          } catch (error) {
             core.warning(`Failed to send notification: ${error.message}`);
          }