commit remaining changes

narethiya-godaddy · narethiya-godaddy · commit ca693b5af809 · 2025-02-25T22:38:07.000+05:30
diff --git a/README.md b/README.md
@@ -1,2 +1,95 @@
-# git-deploy-poc
-Deploy code to remote server
+# GoDaddy GitHub Action for Wordpress deployment
+
+## Overview
+
+This GitHub Action automates WordPress deployment using `rsync` over SSH. It creates a tar archive of modified files, transfers it to the remote server, and executes a deployment script. The action supports post-deployment commands, WordPress health checks, and automatic rollback in case of failures.
+
+## Features
+
+- **Deploy only changed files** using `rsync --checksum`
+- **Remove deleted files** from the repository on the server
+- **Execute post-deployment commands**
+- **Perform WordPress health checks** and rollback if necessary
+- **Secure authentication** via SSH private key
+
+## Usage
+
+### 1. **Add the Action to Your Workflow**
+
+Create a `.github/workflows/deploy.yml` file in your repository:
+
+```yaml
+name: Deploy WordPress
+
+on:
+  workflow_dispatch:
+    inputs:
+      deployment_dest:
+        description: 'Target server directory, leave blank for root directory'
+        required: false
+      enable_health_check:
+        description: 'Enable wordpress health check?'
+        type: choice
+        required: false
+        default: "yes"
+        options:
+          - "yes"
+          - "no"
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Deploy using GitHub Action
+        uses: your-org/your-action-repo@v1
+        with:
+          remote_host: ${{ secrets.REMOTE_HOST }}
+          ssh_user: ${{ secrets.SSH_USER }}
+          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+          deployment_dest: ${{ github.event.inputs.deployment_dest }}
+          enable_health_check: ${{ github.event.inputs.enable_health_check }}
+```
+
+## Inputs
+
+| Name                    | Description                          | Required | Default |
+| ----------------------- | ------------------------------------ | -------- | ------- |
+| `remote_host`           | The remote server IP or domain       | ✅ Yes    | -       |
+| `ssh_user`              | SSH username for authentication      | ✅ Yes    | -       |
+| `ssh_private_key`       | SSH private key for authentication   | ✅ Yes    | -       |
+| `deployment_dest`       | Remote WordPress directory           | ❌ No     | `.`     |
+| `post_deploy_commands`  | Commands to run after deployment     | ❌ No     | `''`    |
+| `cleanup_deleted_files` | Remove deleted files from the server | ❌ No     | `yes`   |
+| `enable_health_check`   | Perform a WordPress health check     | ❌ No     | `yes`   |
+
+## Requirements
+
+- **Enable Git Deployment** for site from GoDaddy interface
+- **GitHub secrets configured** for `REMOTE_HOST`, `SSH_USER`, and `SSH_PRIVATE_KEY`
+
+## Troubleshooting
+
+### SSH Key Issues
+
+Ensure the private key format is correct and matches the server's authorized keys:
+
+```bash
+cat ~/.ssh/id_rsa | base64
+```
+
+Set the output as `SSH_PRIVATE_KEY` in GitHub Secrets.
+
+## License
+
+This action is licensed under the MIT License.
+
+## Contributing
+
+Feel free to open issues or submit PRs for improvements!
+
+## Support
+
+For help, open an issue in the repository.
+
diff --git a/action.yml b/action.yml
@@ -26,20 +26,12 @@ inputs:
     default: ''
   cleanup_deleted_files:
     description: 'Delete files from the server that have been removed from the repository.'
-    type: choice
     required: false
-    default: true
-    options:
-      - "yes"
-      - "no"
+    default: "yes"
   enable_health_check:
     description: 'Check WordPress health after deployment and roll back if it fails. Disable to skip this step.'
-    type: choice
     required: false
     default: "yes"
-    options:
-      - "yes"
-      - "no"
 
 runs:
   using: 'composite'
@@ -49,14 +41,16 @@ runs:
       shell: bash
       run: |
         sudo apt-get update -q && sudo apt-get install -y rsync sshpass
-        
-        OUTPUT_DIR="output"
-        SSH_ROOT_DIR="html"
-        TEMP_KEY_FILE="private_key"
+
+        DEPLOYER_APP_DIR="html/git-deployer"
+        WP_ROOT_DIR="html"
+        UPLOAD_DIR="html/git-deployer-upload"
+
         ACTION_DIR="action_dir"
+        OUTPUT_DIR="output"
         IGNORE_FILES="$ACTION_DIR/files_to_ignore.txt"
         SYNC_FILES="$OUTPUT_DIR/files_to_sync.txt"
-        REMOTE_DIR="$SSH_ROOT_DIR/deployer"
+        TEMP_KEY_FILE="private_key"             
         SSH_AUTH="-i $TEMP_KEY_FILE -o StrictHostKeyChecking=no"
         TAR_NAME="repository_$(openssl rand -hex 4).tar"
 
@@ -70,6 +64,11 @@ runs:
         DEST_DIR="${DEST_DIR%/}" # Remove trailing slash
         echo "DEST_DIR=$DEST_DIR" >> $GITHUB_ENV
         
+        WP_DEST_DIR="$WP_ROOT_DIR/$DEST_DIR"
+        WP_DEST_DIR="${WP_DEST_DIR#/}" # Remove leading slash
+        WP_DEST_DIR="${WP_DEST_DIR%/}" # Remove trailing slash
+        echo "WP_DEST_DIR=$WP_DEST_DIR" >> $GITHUB_ENV
+        
         ACTION_PATH="${{ github.action_path }}"
         TAG_NAME=$(basename "$ACTION_PATH")
         echo "ACTION_TAG=$TAG_NAME" >> $GITHUB_ENV
@@ -80,8 +79,9 @@ runs:
         echo "OUTPUT_DIR=$OUTPUT_DIR" >> $GITHUB_ENV
         echo "SYNC_FILES=$SYNC_FILES" >> $GITHUB_ENV
         echo "DEL_FILE_LIST=$CHECKOUT_DIR/deleted_files.txt" >> $GITHUB_ENV
-        echo "REMOTE_DIR=$REMOTE_DIR" >> $GITHUB_ENV
-        echo "SSH_ROOT_DIR=$SSH_ROOT_DIR" >> $GITHUB_ENV
+        echo "UPLOAD_DIR=$UPLOAD_DIR" >> $GITHUB_ENV
+        echo "DEPLOYER_APP_DIR=$DEPLOYER_APP_DIR" >> $GITHUB_ENV
+        echo "WP_ROOT_DIR=$WP_ROOT_DIR" >> $GITHUB_ENV
         echo "SSH_USER=${{ inputs.ssh_user }}" >> $GITHUB_ENV
         echo "SSH_HOST=${{ inputs.remote_host }}" >> $GITHUB_ENV
         echo "SSH_AUTH=$SSH_AUTH" >> $GITHUB_ENV
@@ -101,10 +101,10 @@ runs:
           echo "The source directory does not exists."
           exit 1
         fi
-        
-        if [[ "$DEST_DIR" != "." ]]; then
-          if ! ssh "$SSH_AUTH" "$SSH_USER@$SSH_HOST" "[ -d '/$SSH_ROOT_DIR/$DEST_DIR' ]"; then
-            echo "Error: Directory '/$SSH_ROOT_DIR/$DEST_DIR' does not exist on the server."
+
+        if [[ "$WP_DEST_DIR" != "$WP_ROOT_DIR" ]]; then
+          if ! ssh "$SSH_AUTH" "$SSH_USER@$SSH_HOST" "[ -d '/$WP_DEST_DIR' ]"; then
+            echo "Error: Directory '/$WP_DEST_DIR' does not exist on the server."
             exit 1
           fi
         fi
@@ -127,15 +127,15 @@ runs:
         echo "ignore list: $EXCLUDE_ARGS"
         echo "Preparing a changed file list..."
         echo "Source: $CHECKOUT_DIR/"
-        echo "Destination: /$SSH_ROOT_DIR/$DEST_DIR/"
+        echo "Destination: /$WP_DEST_DIR/"
         echo "current dir: $(pwd)"
         ls -lha
         echo "rsync command: "
-        echo "rsync -av --dry-run --checksum -e ssh $SSH_AUTH $CHECKOUT_DIR/ $SSH_USER@$SSH_HOST:/$SSH_ROOT_DIR/$DEST_DIR/"
+        echo "rsync -av --dry-run --checksum -e ssh $SSH_AUTH $CHECKOUT_DIR/ $SSH_USER@$SSH_HOST:/$WP_DEST_DIR/"
         
         rsync -av --dry-run --checksum $EXCLUDE_ARGS \
           -e "ssh $SSH_AUTH" \
-          $CHECKOUT_DIR/ "$SSH_USER@$SSH_HOST:/$SSH_ROOT_DIR/$DEST_DIR/" \
+          $CHECKOUT_DIR/ "$SSH_USER@$SSH_HOST:/$WP_DEST_DIR/" \
           | grep -v '/$' > $SYNC_FILES
         
         if [[ $? -ne 0 ]]; then
@@ -151,18 +151,17 @@ runs:
         if [ "$CLEAN_UP" = "yes" ]; then
           touch $DEL_FILE_LIST
           echo "Preparing a deleted file list..."
-          echo "rsync -av --dry-run --delete --ignore-existing -e 'ssh $SSH_AUTH' $CHECKOUT_DIR/ '$SSH_USER@$SSH_HOST:/$SSH_ROOT_DIR/$DEST_DIR/' | grep '^deleting ' | awk '{print $2}' | grep -v '/$' > $DEL_FILE_LIST"
-        
+
           rsync -av --dry-run --delete --ignore-existing $EXCLUDE_ARGS \
             -e "ssh $SSH_AUTH" \
-            $CHECKOUT_DIR/ "$SSH_USER@$SSH_HOST:/$SSH_ROOT_DIR/$DEST_DIR/" \
+            $CHECKOUT_DIR/ "$SSH_USER@$SSH_HOST:/$WP_DEST_DIR/" \
             | grep '^deleting ' | awk '{print $2}' | grep -v '/$' > $DEL_FILE_LIST
-        
+          
           if [[ $? -ne 0 ]]; then
             echo "Error: Failed to prepare the list of files to delete."
             exit 1
           fi
-        
+          
           echo $(basename "$DEL_FILE_LIST") >> "$SYNC_FILES"
           echo "Files to be DELETED:"
           cat "$DEL_FILE_LIST"
@@ -182,11 +181,11 @@ runs:
     - name: Upload tar file to server
       shell: bash
       run: |
-        echo "Creating remote directory: $REMOTE_DIR"
-        ssh $SSH_AUTH "$SSH_USER@$SSH_HOST" "mkdir -p '/$REMOTE_DIR' || exit 1"
+        echo "Creating remote directory: $UPLOAD_DIR"
+        ssh $SSH_AUTH "$SSH_USER@$SSH_HOST" "mkdir -p '/$UPLOAD_DIR' || exit 1"
 
-        echo "Uploading tar file to $REMOTE_DIR"
-        rsync -avz -e "ssh $SSH_AUTH" $TAR_FILE "$SSH_USER@$SSH_HOST:/$REMOTE_DIR/"
+        echo "Uploading tar file to $UPLOAD_DIR"
+        rsync -avz -e "ssh $SSH_AUTH" $TAR_FILE "$SSH_USER@$SSH_HOST:/$UPLOAD_DIR/"
         echo "Tar file uploaded successfully."
 
     - name: Clean up
@@ -202,9 +201,14 @@ runs:
         echo "Run Server deployer"
         POST_COMMAND=${{inputs.post_deploy_commands}}
         HEALTH_CHECK=${{inputs.enable_health_check}}
-        DEPLOYER_SH="/$SSH_ROOT_DIR/deployer.sh"
+        DEPLOYER_SH="php /$DEPLOYER_APP_DIR/bin/init mwp:deployer"
+
+        OPTIONS="--destDir=$DEST_DIR --postDeploymentCommand=$POST_COMMAND"
+        if [ "$HEALTH_CHECK" == "no" ]; then
+          OPTIONS="$OPTIONS --skipHealthCheck"
+        fi
+
+        echo "SSH Command: ssh $SSH_AUTH "$SSH_USER@$SSH_HOST" $DEPLOYER_SH $TAR_NAME $OPTIONS"; 
+        ssh $SSH_AUTH "$SSH_USER@$SSH_HOST" $DEPLOYER_SH $TAR_NAME $OPTIONS 
 
-        ssh $SSH_AUTH "$SSH_USER@$SSH_HOST" \ 
-          $DEPLOYER_SH $TAR_NAME $DEST_DIR $HEALTH_CHECK $POST_COMMAND
-        
         rm -f $TEMP_KEY_FILE
diff --git a/files_to_ignore.txt b/files_to_ignore.txt
@@ -27,4 +27,6 @@ wp-admin/
 wp-includes/
 wp-content/mu-plugins/
 wp-content/object-cache.php
-wp-content/uploads/
+wp-content/uploads/
+git-deployer/
+git-deployer-upload/
