Skip to content

Commit 6448ef8

Browse files
committed
Update instructions
1 parent 5129d1d commit 6448ef8

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,26 @@
22

33
Interactive debugger for GitHub Actions
44

5+
## Usage
6+
7+
In the log for the action you will see:
8+
9+
```
10+
Running tmate...
11+
12+
To connect to this session copy-n-paste the following into a terminal:
13+
14+
15+
```
16+
17+
Simply follow the instructions and copy the ssh command into your terminal to create an ssh connection the running instance. The session will close immedeatly after closing the ssh connection to the running instance.
18+
19+
There is a global timeout after 15 minutes. This will close any open ssh sessions. To prevent the session from being terminated run:
20+
21+
```
22+
touch /tmp/keepalive
23+
```
24+
525
## Acknowledgments
626

727
* [tmate.io](https://tmate.io)

script.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ echo To connect to this session copy-n-paste the following into a terminal:
2424
tmate -S /tmp/tmate.sock display -p '#{tmate_ssh}'
2525

2626
# Wait for connection to close or timeout in 15 min
27-
timeout=$((2*60))
27+
timeout=$((15*60))
2828
while [ -S /tmp/tmate.sock ]; do
2929
sleep 1
3030
timeout=$(($timeout-1))
3131

32-
if [ ! -f /tmp/keepalive ] ; then
32+
if [ ! -f /tmp/keepalive ]; then
3333
if (( timeout < 0 )); then
3434
echo Waiting on tmate connection timed out!
3535
exit 1

0 commit comments

Comments
 (0)