🚀 SSH Session Action

name: Debug Workflow
on: workflow_dispatch

# Define environment variables in GitHub UI (Repository Settings → Variables)
env:
  SSH_JUMP_HOST: 'your-jump-host.net'
  SSH_JUMP_PORT: '22'
  SSH_JUMP_USER: 'your-user'
  SSH_JUMP_FORWARD: '2222'
  SSH_JUMP_HOST_KEYS: |
    your-jump-host.net ssh-rsa AAAAB3NzaC1yc2E...

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup SSH Debug Session
        uses: lexbritvin/ssh-session-action@v1
        with:
          ssh-jump-host: ${{ env.SSH_JUMP_HOST }}
          ssh-jump-port: ${{ env.SSH_JUMP_PORT }}
          ssh-jump-user: ${{ env.SSH_JUMP_USER }}
          ssh-jump-host-keys: ${{ env.SSH_JUMP_HOST_KEYS }}
          ssh-jump-forward: ${{ env.SSH_JUMP_FORWARD }}
          ssh-jump-private-key: ${{ secrets.SSH_PRIVATE_KEY }} # Add to GitHub Secrets (not needed for public hosts)
          ssh-server-authorized-keys: ${{ secrets.SSH_PUBLIC_KEYS }}      # Add to GitHub Secrets
          use-actor-ssh-keys: 'true'

name: Debug with Bore
on: workflow_dispatch

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup SSH Debug Session (Bore)
        uses: lexbritvin/ssh-session-action@v1
        with:
          use-bore: 'true'
          use-actor-ssh-keys: 'true'
          ssh-server-authorized-keys: ${{ secrets.SSH_PUBLIC_KEYS }}

env:
  SSH_JUMP_HOST: 'ssh-j.com'
  SSH_JUMP_USER: ':generate' # Generates a scoped user for host alias
  SSH_JUMP_FORWARD: ':generate' # Generates a unique host alias within the jump host
  SSH_JUMP_HOST_KEYS: |
    ssh-j.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC...

env:
  SSH_JUMP_HOST: 'free.pinggy.io'
  SSH_JUMP_PORT: '443'
  SSH_JUMP_USER: 'tcp'  # Use 'tcp' to forward any TCP connection
  SSH_JUMP_FORWARD: '0' # Use random port allocation
  SSH_JUMP_HOST_KEYS: |
    [free.pinggy.io]:443 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC...

env:
  SSH_JUMP_HOST: 'serveo.net'
  SSH_JUMP_PORT: '22'
  SSH_JUMP_FORWARD: ':generate' # Generates a unique host alias (can also use '0' for random public port)
  SSH_JUMP_HOST_KEYS: |
    serveo.net ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC...

- name: Setup SSH with Bore (Default)
  uses: lexbritvin/ssh-session-action@v1
  with:
    use-bore: 'true'
    use-actor-ssh-keys: 'true'

- name: Setup SSH with Custom Bore Server
  uses: lexbritvin/ssh-session-action@v1
  with:
    use-bore: 'true'
    bore-server: 'your-bore-server.com:2200'
    bore-secret: ${{ secrets.BORE_SECRET }}
    use-actor-ssh-keys: 'true'

name: Debug on Failure
on: [ push, pull_request ]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run Tests
        run: npm test
        continue-on-error: true

      - name: Setup Debug Session on Failure
        if: failure()
        uses: lexbritvin/ssh-session-action@v1
        with:
          use-bore: 'true'
          ssh-server-authorized-keys: ${{ secrets.SSH_PUBLIC_KEYS }}
          use-actor-ssh-keys: 'true'

- name: Start SSH Debug Session (Background)
  id: ssh-session
  uses: lexbritvin/ssh-session-action@v1
  with:
    use-bore: 'true'
    ssh-server-authorized-keys: ${{ secrets.SSH_PUBLIC_KEYS }}
    use-actor-ssh-keys: 'true'
    display-help-message: 'false'
    detached: true

- name: Send Slack Notification
  uses: 8398a7/action-slack@v3
  with:
    status: custom
    custom_payload: |
      {
        "text": "🚀 SSH Debug Session Active",
        "blocks": [
          {
            "type": "section",
            "text": {
              "type": "mrkdwn",
              "text": "```${{ steps.ssh-session.outputs.ssh-command }}```"
            }
          }
        ]
      }

- name: 👉 How to connect 👈
  env:
    HELP_MESSAGE: ${{ steps.ssh-session.outputs.help-message }}
    EXTRA_HELP: |
      ╔══════════════════════════════════════════════════════════════════════════════════════════╗
                                    🐛 GO DEBUGGING WITH DELVE                                  
      ╚══════════════════════════════════════════════════════════════════════════════════════════╝

      \033[1;32m┌─ 🔄 PORT FORWARDING FOR DELVE\033[0m
      \033[1;32m│\033[0m   \033[1mssh -L 2345:localhost:2345 ...\033[0m
      \033[1;32m└─\033[0m

      \033[1;33m┌─ 🛠️  DEBUG COMMANDS\033[0m
      \033[1;33m│\033[0m   \033[1;35mRun all tests:\033[0m
      \033[1;33m│\033[0m     \033[1mgo test ./...\033[0m
      \033[1;33m│\033[0m   \033[1;35mRun specific test:\033[0m
      \033[1;33m│\033[0m     \033[1mgo test -v -run TestFooBar ./...\033[0m
      \033[1;33m│\033[0m   \033[1;35mDebug specific test:\033[0m
      \033[1;33m│\033[0m     \033[1mdlv --listen=:2345 --headless --api-version=2 test ./... -- -test.run TestFooBar\033[0m
      \033[1;33m│\033[0m   \033[1;35mDebug application:\033[0m
      \033[1;33m│\033[0m     \033[1mdlv debug --headless --listen=:2345 --api-version=2 ./cmd/foo -- [args...]\033[0m
      \033[1;33m└─\033[0m

      \033[1;34m┌─ 🔗 IDE INTEGRATION\033[0m
      \033[1;34m│\033[0m   \033[1;36mConnect to Delve on port 2345:\033[0m
      \033[1;34m│\033[0m   \033[1;36m•\033[0m \033[1;35mVS Code:\033[0m https://github.com/golang/vscode-go/blob/master/docs/debugging.md
      \033[1;34m│\033[0m   \033[1;36m•\033[0m \033[1;35mGoLand/IntelliJ:\033[0m https://www.jetbrains.com/help/go/attach-to-running-go-processes-with-debugger.html#attach-to-a-process-on-a-remote-machine
      \033[1;34m└─\033[0m

      \033[1;36m📚 Delve Documentation:\033[0m https://github.com/go-delve/delve/tree/master/Documentation
  shell: bash
  run: |
    echo "SSH Debug Session Started!"
    # The help-message output contains ANSI color codes (\033[1;32m etc.)
    # Use printf to properly display colored output
    printf "%b\n%b\n" "$HELP_MESSAGE" "$EXTRA_HELP"

name: Debug with Tailscale
on: workflow_dispatch

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Connect to Tailscale
        uses: tailscale/github-action@v2
        with:
          oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
          oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
          tags: tag:ci

      - name: Get Tailscale IP
        id: tailscale-ip
        run: |
          TAILSCALE_IP=$(tailscale ip -4)
          echo "ip=$TAILSCALE_IP" >> $GITHUB_OUTPUT
          echo "🌐 Runner accessible at: $TAILSCALE_IP"

      - name: Setup SSH Debug (Tailscale Direct)
        uses: lexbritvin/ssh-session-action@v1
        with:
          # No jump host needed - direct connection via Tailscale
          ssh-server-host: ${{ steps.tailscale-ip.outputs.ip }}
          ssh-server-port: 2223
          use-actor-ssh-keys: true
          wait-timeout: 3600

- name: SSH Debug with Skipped Host Check
  uses: lexbritvin/ssh-session-action@v1
  with:
    ssh-jump-host: ${{ env.SSH_JUMP_HOST }}
    # Do not check a server key and use verbose SSH output
    ssh-jump-extra-flags: "-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -vvv"
    use-actor-ssh-keys: true