Add support for a "detached" mode #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sometimes it is nicer when things are quiet. In the upcoming commit, I will introduce a caller that does want to consume the output of a shell command without having its output clutter the job's logs. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
In "detached" mode, the `tmate` session will be created, the Action will then print the information how to connect, and then exit with success. The workflow job's steps will run concurrently with the `tmate` session, allowing the user to monitor the steps as they are progressing. At the end of the job, the Action's newly-introduced post-job Action will wait until the session is ended, or up to 10 minutes for any client to connect at all. This detached mode is inspired by CircleCI/CirrusCI's debugging support that _only_ allows a concurrent shell terminal to be opened. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
To better assess how useful the detached mode is, and whether it handles all of the corner cases correctly (client connects only during the post job phase, job is canceled while waiting for the session to end, etc), let's have a GitHub workflow that can be triggered manually. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #131, first, and then in #156, a change was proposed to support the same functionality as CircleCI, where a terminal is open concurrent to the running job's steps. And as I mentioned in the latter PR, I have found that feature quite useful (implementing it "manually", by having two
shell: bashsteps).Here is a very small PR to propose a much simpler UI but essentially offer the same feature: by setting the input
detached: true, theaction-tmatestep will start a new, detachedtmatesession, print the information how to connect to that, and then continue with the workflow job's next steps, keeping thetmatesession running. In the post-job phase,action-tmatewill then wait for the session to end (or, if nobody connected to the session within 10 minutes of that post-job Action, terminate anyway).Sadly, this PR results in warnings about the usage of the
save-statecommand that would only be solved by upgrading to@actions/core1.10.0. However, in #152 we tried that and the same blockers are still there. So I'll punt on that, for now.