{"repo":"mxschmitt/action-tmate","free":true,"listed":false,"github":"https://github.com/mxschmitt/action-tmate","clone":"git clone https://github.com/mxschmitt/action-tmate.git","description":"Debug your GitHub Actions via SSH by using tmate to get access to the runner system itself.","language":"JavaScript","stars":3577,"topics":["github-actions","github-action","tmate","ssh","debugging","actions","hacktoberfest"],"license":"MIT","category":"dev-tools","readme_excerpt":"Debug your GitHub Actions by using tmate This GitHub Action offers you a direct way to interact with the host system on which the actual scripts (Actions) will run. Features - Debug your GitHub Actions by using SSH or Web shell - Continue your Workflows afterwards Supported Operating Systems - Linux - macOS - Windows Getting Started By using this minimal example a tmate session will be created. To get the connection string, just open the Checks tab in your Pull Request and scroll to the bottom. There you can connect either directly per SSH or via a web based terminal. Manually triggered debug Instead of having to add/remove, or uncomment the required config and push commits each time you want to run your workflow with debug, you can make the debug step conditional on an optional parameter that you provide through a workflow dispatch \"manual event\". Add the following to the on events of your workflow: Then add an if condition to the debug step: You can then manually run a workflow on the desired branch and set debug enabled to true to get a debug session. Detached mode By default, this Action starts a tmate session and waits for the session to be done (typically by way of a user connecting and exiting the shell after debugging). In detached mode, this Action will start the tmate session, print the connection details, and continue with the next step(s) of the workflow's job. At the end of the job, the Action will wait for the session to exit. By default, this mode will wait at ","default_branch":null,"files":null,"tree":[],"storefront":"/r/mxschmitt","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mxschmitt/action-tmate/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}