action.yml

name: 'Permaweb Deploy'
description: 'Deploy static sites to Arweave and update ArNS records. Perfect for PR previews and production deployments.'
author: 'permaweb'
branding:
  icon: 'upload-cloud'
  color: 'blue'

inputs:
  deploy-key:
    description: 'Arweave JWK wallet (base64-encoded or JSON string) for Arweave signer, or raw private key for Ethereum/Polygon/KYVE signers'
    required: true
  arns-name:
    description: 'The ArNS name to update (e.g., "myapp" for myapp.arweave.net)'
    required: true
  undername:
    description: 'The undername to use. Use "@" for base name, or a custom value for undernames (e.g., "docs" for docs_myapp.arweave.net)'
    required: false
    default: '@'
  deploy-folder:
    description: 'Path to the folder containing built static files to deploy'
    required: false
    default: './dist'
  deploy-file:
    description: 'Path to a single file to deploy (alternative to deploy-folder)'
    required: false
  ttl-seconds:
    description: 'TTL in seconds for the ANT record (60-86400)'
    required: false
    default: '3600'
  sig-type:
    description: 'Signer type for deployment (arweave, ethereum, polygon, kyve)'
    required: false
    default: 'arweave'
  ario-process:
    description: 'ARIO process to use (mainnet, testnet, or a custom process ID)'
    required: false
    default: 'mainnet'
  on-demand:
    description: 'Enable on-demand payment with specified token (ario or base-eth)'
    required: false
  max-token-amount:
    description: 'Maximum token amount for on-demand payment (used with on-demand)'
    required: false
  preview:
    description: 'Enable preview mode: auto-generates undername from PR number and posts a comment with the preview URL'
    required: false
    default: 'false'
  auto-undername:
    description: 'Automatically generate undername from PR number or branch name (use preview for full PR preview functionality)'
    required: false
    default: 'false'
  github-token:
    description: 'GitHub token for posting PR comments (required when preview is enabled)'
    required: false

outputs:
  tx-id:
    description: 'The Arweave transaction ID of the uploaded content'
    value: ${{ steps.deploy.outputs.tx-id }}
  deployment-url:
    description: 'The full URL where the deployment is accessible'
    value: ${{ steps.deploy.outputs.deployment-url }}
  undername-used:
    description: 'The undername that was used for the deployment'
    value: ${{ steps.deploy.outputs.undername-used }}

runs:
  using: 'composite'
  steps:
    - name: Setup Node.js
      uses: actions/setup-node@v4
      with:
        node-version: '20'

    - name: Install permaweb-deploy
      shell: bash
      run: npm install -g permaweb-deploy

    - name: Determine undername
      id: undername
      shell: bash
      run: |
        UNDERNAME="${{ inputs.undername }}"
        AUTO_UNDERNAME="${{ inputs.auto-undername }}"
        PREVIEW="${{ inputs.preview }}"

        # Preview mode implies auto-undername
        if [[ "$PREVIEW" == "true" ]]; then
          AUTO_UNDERNAME="true"
        fi

        if [[ "$AUTO_UNDERNAME" == "true" && "$UNDERNAME" == "@" ]]; then
          # Get sanitized repository name
          REPO_NAME=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_-]/-/g' | sed 's/--*/-/g' | sed 's/^-//' | sed 's/-$//')
          
          # Check if this is a pull request
          if [[ -n "${{ github.event.pull_request.number }}" ]]; then
            UNDERNAME="${REPO_NAME}-pr-${{ github.event.pull_request.number }}"
            echo "Auto-generated undername from PR: $UNDERNAME"
          elif [[ -n "${{ github.ref_name }}" && "${{ github.ref_name }}" != "main" && "${{ github.ref_name }}" != "master" ]]; then
            # Sanitize branch name for use as undername
            BRANCH_NAME=$(echo "${{ github.ref_name }}" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_-]/-/g' | sed 's/--*/-/g' | sed 's/^-//' | sed 's/-$//')
            UNDERNAME="${REPO_NAME}-${BRANCH_NAME}"
            echo "Auto-generated undername from branch: $UNDERNAME"
          fi
          
          # Ensure length constraints: < 61 chars and != 43 chars
          if [[ ${#UNDERNAME} -ge 61 ]]; then
            # Truncate to 60 characters
            UNDERNAME="${UNDERNAME:0:60}"
            echo "Truncated undername to 60 characters: $UNDERNAME"
          fi
          
          # Avoid exactly 43 characters (Arweave transaction ID length)
          if [[ ${#UNDERNAME} -eq 43 ]]; then
            # Append 'x' to make it 44 characters
            UNDERNAME="${UNDERNAME}x"
            echo "Adjusted undername to avoid 43 characters: $UNDERNAME"
          fi
        fi

        echo "undername=$UNDERNAME" >> $GITHUB_OUTPUT

    - name: Deploy to Permaweb
      id: deploy
      shell: bash
      env:
        DEPLOY_KEY: ${{ inputs.deploy-key }}
      run: |
        # Handle deploy key format (base64 or JSON)
        if [[ "$DEPLOY_KEY" =~ ^[A-Za-z0-9+/]+=*$ ]]; then
          # Looks like base64, use as is
          echo "Deploy key appears to be base64 encoded"
        elif [[ "$DEPLOY_KEY" =~ ^\{.*\}$ ]]; then
          # JSON format, encode to base64
          echo "Deploy key is JSON, encoding to base64"
          DEPLOY_KEY=$(echo -n "$DEPLOY_KEY" | base64)
        fi

        # Build command arguments
        ARGS="--arns-name ${{ inputs.arns-name }}"
        ARGS="$ARGS --undername ${{ steps.undername.outputs.undername }}"
        ARGS="$ARGS --ttl-seconds ${{ inputs.ttl-seconds }}"
        ARGS="$ARGS --sig-type ${{ inputs.sig-type }}"
        ARGS="$ARGS --ario-process ${{ inputs.ario-process }}"

        # Add deploy-folder or deploy-file
        if [[ -n "${{ inputs.deploy-file }}" ]]; then
          ARGS="$ARGS --deploy-file ${{ inputs.deploy-file }}"
        else
          ARGS="$ARGS --deploy-folder ${{ inputs.deploy-folder }}"
        fi

        # Add on-demand payment options if specified
        if [[ -n "${{ inputs.on-demand }}" ]]; then
          ARGS="$ARGS --on-demand ${{ inputs.on-demand }}"
          if [[ -n "${{ inputs.max-token-amount }}" ]]; then
            ARGS="$ARGS --max-token-amount ${{ inputs.max-token-amount }}"
          fi
        fi

        echo "Running: permaweb-deploy deploy $ARGS"

        # Run deploy and capture output
        OUTPUT=$(permaweb-deploy deploy $ARGS 2>&1) || {
          echo "Deployment failed"
          echo "$OUTPUT"
          exit 1
        }

        echo "$OUTPUT"

        # Extract transaction ID from output (look for "Tx ID" in the table)
        TX_ID=$(echo "$OUTPUT" | grep -oP 'Tx ID\s*│\s*\K[a-zA-Z0-9_-]{43}' || echo "")
        if [[ -z "$TX_ID" ]]; then
          # Try alternative patterns
          TX_ID=$(echo "$OUTPUT" | grep -oE '[a-zA-Z0-9_-]{43}' | head -1 || echo "")
        fi

        echo "tx-id=$TX_ID" >> $GITHUB_OUTPUT
        echo "undername-used=${{ steps.undername.outputs.undername }}" >> $GITHUB_OUTPUT

        # Build deployment URL
        ARNS_NAME="${{ inputs.arns-name }}"
        UNDERNAME="${{ steps.undername.outputs.undername }}"
        if [[ "$UNDERNAME" == "@" ]]; then
          DEPLOYMENT_URL="https://${ARNS_NAME}.ar.io"
        else
          DEPLOYMENT_URL="https://${UNDERNAME}_${ARNS_NAME}.ar.io"
        fi

        echo "deployment-url=$DEPLOYMENT_URL" >> $GITHUB_OUTPUT
        echo "Deployment URL: $DEPLOYMENT_URL"

    - name: Comment on PR
      if: inputs.preview == 'true' && github.event_name == 'pull_request'
      uses: actions/github-script@v7
      with:
        github-token: ${{ inputs.github-token }}
        script: |
          const deploymentUrl = '${{ steps.deploy.outputs.deployment-url }}';
          const txId = '${{ steps.deploy.outputs.tx-id }}';
          const undername = '${{ steps.deploy.outputs.undername-used }}';
          const arnsName = '${{ inputs.arns-name }}';

          const body = `## Permaweb Preview Deployed

          Your preview is available at: **${deploymentUrl}**

          | Property | Value |
          |----------|-------|
          | Transaction ID | \`${txId}\` |
          | ArNS Name | ${arnsName} |
          | Undername | ${undername} |

          > This preview will be available permanently on Arweave via the [AR.IO Network](https://ar.io).`;

          // Find existing comment
          const { data: comments } = await github.rest.issues.listComments({
            owner: context.repo.owner,
            repo: context.repo.repo,
            issue_number: context.issue.number,
          });

          const botComment = comments.find(comment =>
            comment.body.includes('Permaweb Preview Deployed')
          );

          if (botComment) {
            // Update existing comment
            await github.rest.issues.updateComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              comment_id: botComment.id,
              body: body
            });
          } else {
            // Create new comment
            await github.rest.issues.createComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
              body: body
            });
          }

    - name: Delete undername on PR close
      if: github.event_name == 'pull_request' && github.event.action == 'closed' && steps.undername.outputs.undername != '@' && (inputs.auto-undername == 'true' || inputs.preview == 'true')
      shell: bash
      env:
        DEPLOY_KEY: ${{ inputs.deploy-key }}
      run: |
        UNDERNAME="${{ steps.undername.outputs.undername }}"

        # Safety check: never delete the @ undername (base record)
        if [[ "$UNDERNAME" == "@" ]]; then
          echo "Safety check: Cannot delete the base record (@). Skipping deletion."
          exit 0
        fi

        echo "Deleting undername '$UNDERNAME' for ArNS name '${{ inputs.arns-name }}'..."

        # Handle deploy key format (base64 or JSON)
        if [[ "$DEPLOY_KEY" =~ ^[A-Za-z0-9+/]+=*$ ]]; then
          # Already base64, use as is
          echo "Deploy key is already base64 encoded"
        elif [[ "$DEPLOY_KEY" =~ ^\{.*\}$ ]]; then
          # JSON format, encode to base64
          echo "Deploy key is JSON, encoding to base64"
          DEPLOY_KEY=$(echo -n "$DEPLOY_KEY" | base64)
        fi

        # Get the ANT process ID for the ArNS name
        echo "Getting ArNS record to find ANT process ID..."
        PROCESS_ID=$(ar.io get-arns-record --name "${{ inputs.arns-name }}" --json | jq -r '.processId' 2>/dev/null) || {
          echo "Warning: Failed to get ArNS record. The record may not exist."
          exit 0
        }

        if [[ -z "$PROCESS_ID" || "$PROCESS_ID" == "null" ]]; then
          echo "Warning: No process ID found for ArNS name '${{ inputs.arns-name }}'"
          exit 0
        fi

        echo "Found ANT process ID: $PROCESS_ID"

        # Remove the undername from the ANT
        ar.io remove-ant-record \
          --process-id "$PROCESS_ID" \
          --undername "${{ steps.undername.outputs.undername }}" \
          --private-key "$DEPLOY_KEY" \
          2>&1 || {
          echo "Warning: Failed to delete undername. It may have already been deleted or may not exist."
          # Don't fail the workflow if deletion fails
        }

    - name: Comment on PR close
      if: github.event_name == 'pull_request' && github.event.action == 'closed' && inputs.github-token != ''
      uses: actions/github-script@v7
      with:
        github-token: ${{ inputs.github-token }}
        script: |
          const undername = '${{ steps.undername.outputs.undername }}';
          const arnsName = '${{ inputs.arns-name }}';
          let deploymentUrl;

          if (undername === '@') {
            deploymentUrl = `https://${arnsName}.ar.io`;
          } else {
            deploymentUrl = `https://${undername}_${arnsName}.ar.io`;
          }

          let body;
          if (undername !== '@') {
            body = `## Pull Request Closed

          This PR has been closed. The undername \`${undername}\` has been removed from the ArNS record.

          The deployment remains permanently available on Arweave at its transaction ID.

          > Note: The preview URL (${deploymentUrl}) is no longer accessible as the undername has been deleted.`;
          } else {
            body = `## Pull Request Closed

          This PR has been closed. The deployment remains available at:
          **${deploymentUrl}**

          > Arweave deployments are permanent and will continue to be accessible.`;
          }

          await github.rest.issues.createComment({
            owner: context.repo.owner,
            repo: context.repo.repo,
            issue_number: context.issue.number,
            body: body
          });