From 4a8ccc603bb245edcf22c378f39771c7d32af072 Mon Sep 17 00:00:00 2001
From: Alex Skrypnyk <alex@drevops.com>
Date: Fri, 6 Sep 2024 14:14:03 +1000
Subject: [PATCH] Replaced `upterm` with `tmate`.

---
 .github/workflows/test-nodejs.yml   | 11 +++++------
 .github/workflows/test-php.yml      | 24 +++++++++++-------------
 .github/workflows/test-scaffold.yml | 13 ++++++-------
 .github/workflows/test-shell.yml    | 13 ++++++-------
 docs/content/ci/README.mdx          |  2 +-
 docs/cspell.json                    |  5 +++--
 6 files changed, 32 insertions(+), 36 deletions(-)

diff --git a/.github/workflows/test-nodejs.yml b/.github/workflows/test-nodejs.yml
index 63b63e2..723cb59 100644
--- a/.github/workflows/test-nodejs.yml
+++ b/.github/workflows/test-nodejs.yml
@@ -10,8 +10,8 @@ on:
       - 'feature/**'
   workflow_dispatch:
     inputs:
-      enable_upterm:
-        description: 'Set "true" to enable upterm session.'
+      enable_terminal:
+        description: 'Set "true" to enable terminal session.'
         required: true
 
 jobs:
@@ -42,8 +42,7 @@ jobs:
         run: npm run test
         continue-on-error: ${{ vars.CI_TEST_IGNORE_FAILURE == '1' }}
 
-      - name: Setup upterm session
+      - name: Setup tmate session
         if: ${{ !cancelled() && github.event.inputs.enable_upterm == 'true' }}
-        uses: lhotari/action-upterm@v1
-        with:
-          wait-timeout-minutes: 5
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 5
diff --git a/.github/workflows/test-php.yml b/.github/workflows/test-php.yml
index 07fc62f..896e840 100644
--- a/.github/workflows/test-php.yml
+++ b/.github/workflows/test-php.yml
@@ -10,8 +10,8 @@ on:
       - 'feature/**'
   workflow_dispatch:
     inputs:
-      enable_upterm:
-        description: 'Set "true" to enable upterm session.'
+      enable_terminal:
+        description: 'Set "true" to enable terminal session.'
         required: true
 
 jobs:
@@ -73,11 +73,10 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-      - name: Setup upterm session
-        if: ${{ !cancelled() && github.event.inputs.enable_upterm == 'true' }}
-        uses: lhotari/action-upterm@v1
-        with:
-          wait-timeout-minutes: 5
+      - name: Setup tmate session
+        if: ${{ !cancelled() && github.event.inputs.enable_terminal == 'true' }}
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 5
 
   # yamllint disable-line #;< PHP_PHAR
   build-php:
@@ -106,9 +105,8 @@ jobs:
       - name: Test PHAR
         run: ./.build/php-command.phar || exit 1
 
-      - name: Setup upterm session
-        if: ${{ !cancelled() && github.event.inputs.enable_upterm == 'true' }}
-        uses: lhotari/action-upterm@v1
-        with:
-          wait-timeout-minutes: 5
-          # yamllint disable-line #;> PHP_PHAR
+      - name: Setup tmate session
+        if: ${{ !cancelled() && github.event.inputs.enable_terminal == 'true' }}
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 5
+  # yamllint disable-line #;> PHP_PHAR
diff --git a/.github/workflows/test-scaffold.yml b/.github/workflows/test-scaffold.yml
index d48c207..32c5e51 100644
--- a/.github/workflows/test-scaffold.yml
+++ b/.github/workflows/test-scaffold.yml
@@ -14,8 +14,8 @@ on:
       - 'feature/**'
   workflow_dispatch:
     inputs:
-      enable_upterm:
-        description: 'Set "true" to enable upterm session.'
+      enable_terminal:
+        description: 'Set "true" to enable terminal session.'
         required: true
 
 jobs:
@@ -67,8 +67,7 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-      - name: Setup upterm session
-        if: ${{ !cancelled() && github.event.inputs.enable_upterm == 'true' }}
-        uses: lhotari/action-upterm@v1
-        with:
-          wait-timeout-minutes: 5
+      - name: Setup tmate session
+        if: ${{ !cancelled() && github.event.inputs.enable_terminal == 'true' }}
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 5
diff --git a/.github/workflows/test-shell.yml b/.github/workflows/test-shell.yml
index 6f98755..6803368 100644
--- a/.github/workflows/test-shell.yml
+++ b/.github/workflows/test-shell.yml
@@ -10,8 +10,8 @@ on:
       - 'feature/**'
   workflow_dispatch:
     inputs:
-      enable_upterm:
-        description: 'Set "true" to enable upterm session.'
+      enable_terminal:
+        description: 'Set "true" to enable terminal session.'
         required: true
 
 env:
@@ -89,8 +89,7 @@ jobs:
         shell: bash
         continue-on-error: ${{ vars.CI_TEST_IGNORE_FAILURE == '1' }}
 
-      - name: Setup upterm session
-        if: ${{ !cancelled() && github.event.inputs.enable_upterm == 'true' }}
-        uses: lhotari/action-upterm@v1
-        with:
-          wait-timeout-minutes: 5
+      - name: Setup tmate session
+        if: ${{ !cancelled() && github.event.inputs.enable_terminal == 'true' }}
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 5
diff --git a/docs/content/ci/README.mdx b/docs/content/ci/README.mdx
index dfe0b30..c790b70 100644
--- a/docs/content/ci/README.mdx
+++ b/docs/content/ci/README.mdx
@@ -40,7 +40,7 @@ This project provides several GitHub Actions workflows to help you get started.
 ### SSHing into a GitHub Actions runner
 
 If you need to SSH into a GitHub Actions runner to debug your workflows, you can
-start an action manually using [lhotari/action-upterm](https://github.com/lhotari/action-upterm)
+start an action manually using [mxschmitt/action-tmate](https://github.com/mxschmitt/action-tmate)
 added to PHP, Node.js, and Shell workflows.
 
 This will post the SSH details into the Actions logs looking like:
diff --git a/docs/cspell.json b/docs/cspell.json
index c5f54b0..f1ec6c4 100644
--- a/docs/cspell.json
+++ b/docs/cspell.json
@@ -14,10 +14,11 @@
         "daemonized",
         "lhotari",
         "mksh",
+        "mxschmitt",
         "ruleset",
         "softprops",
-        "toshimaru",
-        "upterm"
+        "tmate",
+        "toshimaru"
     ],
     "overrides": [
         {