Skip to content

Commit

Permalink
Update action-upterm instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
owenthereal committed May 27, 2024
1 parent e196415 commit 3289244
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Clients can connect to the host session via WebSocket as well:
ssh -o ProxyCommand='upterm proxy wss://[email protected]' [email protected]:443
```

## :bug: Debug GitHub Actions
### Debug GitHub Actions

`upterm` can be integrated with GitHub Actions to enable real-time SSH debugging, allowing you to interact directly with the runner system during workflow execution. This is achieved through [action-upterm](https://github.com/owenthereal/action-upterm), which sets up an `upterm` session within your CI pipeline.

Expand All @@ -118,7 +118,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Setup upterm session
uses: owenthereal/action-upterm@main
uses: owenthereal/action-upterm@v1
```
This setup allows you to SSH into the workflow runner whenever you need to troubleshoot or inspect the execution environment. Find the SSH connection string in the `Checks` tab of your Pull Request or in the workflow logs.
Expand Down

0 comments on commit 3289244

Please sign in to comment.