Add support for the ssh commands in output #221
Merged
Conversation
This file contains hidden or 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
|
I am probably too blessed with excellent commit message that follow the guidance in https://github.blog/2022-06-30-write-better-commits-build-better-projects/ to improve it, in particular with a strong focus on this part:
And I am probably too used to excellent PR descriptions that don't require the reviewer to look elsewhere for a convincing argument that motivates why a feature should be added. And the change to the README is... a change to the README and not that, it is not a succinct pitch for a new feature. In this instance, I think that the PR description should have been something like this: In complex corporate setups, it is not uncommon that CI processes are designed to notify engineers at strategic times during lengthy workflows. To integrate |
dscho
reviewed
Apr 30, 2025
Comment on lines
+59
to
+66
|
|
||
| outputs: | ||
| ssh-command: | ||
| description: 'The SSH command to connect to the tmate session (only set when detached mode is enabled)' | ||
| ssh-address: | ||
| description: 'The raw SSH address without the "ssh" prefix (only set when detached mode is enabled)' | ||
| web-url: | ||
| description: 'The web URL to connect to the tmate session (only set when detached mode is enabled and web URL is available)' |
There was a problem hiding this comment.
Please also add this to detached/action.yml.
|
@dscho Thanks! I've made the suggested changes, and that context you gave is helpful! |
All but the more complete commit message 😉
Excellent! Thank you for your contribution! |
dscho
added a commit
that referenced
this pull request
May 1, 2025
In #218, I added a convenient way to launch this Action in detached mode: `mxschmitt/action-tmate/detached@v3`. The way this is implemented is a copy/edited version of `action.yml` in the `detached/` subdirectory. This runs the danger of inadvertent divergences, as happened in #221 (which I caught in time and the contributor gracefully addressed). Let's add automation not only to update the file easily but also to cause a failure in the PR build with a helpful message suggesting how to fix the problem. Signed-off-by: Johannes Schindelin <[email protected]>
dscho
added a commit
that referenced
this pull request
May 1, 2025
In #218, I added a convenient way to launch this Action in detached mode: `mxschmitt/action-tmate/detached@v3`. The way this is implemented is a copy/edited version of `action.yml` in the `detached/` subdirectory. This runs the danger of inadvertent divergences, as happened in #221 (which I caught in time and the contributor gracefully addressed). Let's add automation not only to update the file easily but also to cause a failure in the PR build with a helpful message suggesting how to fix the problem. Signed-off-by: Johannes Schindelin <[email protected]>
dscho
added a commit
that referenced
this pull request
May 1, 2025
In #218, I added a convenient way to launch this Action in detached mode: `mxschmitt/action-tmate/detached@v3`. The way this is implemented is a copy/edited version of `action.yml` in the `detached/` subdirectory. This runs the danger of inadvertent divergences, as happened in #221 (which I caught in time and the contributor gracefully addressed). Let's add automation not only to update the file easily but also to cause a failure in the PR build with a helpful message suggesting how to fix the problem. Signed-off-by: Johannes Schindelin <[email protected]>
yanksyoon
added a commit
to canonical/action-tmate
that referenced
this pull request
May 15, 2025
* Don't create /continue on macOS * add connect-timeout variable Signed-off-by: Dave Lee <[email protected]> * run the build Signed-off-by: Dave Lee <[email protected]> * action.yml Signed-off-by: Dave Lee <[email protected]> * connect-timeout-seconds is a better name Signed-off-by: Dave Lee <[email protected]> * chore(deps): bump to use actions/checkout v4 (node20 runtime) (mxschmitt#197) * chore(deps-dev): bump braces from 3.0.2 to 3.0.3 (mxschmitt#196) * chore(deps-dev): bump micromatch from 4.0.5 to 4.0.8 (mxschmitt#201) * Adding support for RHEL-based distributions Signed-off-by: Loic Pottier <[email protected]> Signed-off-by: Johannes Schindelin <[email protected]> * chore(deps-dev): bump cross-spawn from 7.0.3 to 7.0.5 (mxschmitt#207) * add new input msys2-location add new msys2-location input and use instead of hardcoding c:\msys64 * Update README.md with new input * Update index.js * use msys2-location input in didTmateQuit and continueFileExists * Offer `mxschmitt/action-tmate/detached` for convenience The `mxschmitt/action-tmate/detached` Action does exactly the same as the `mxschmitt/action-tmate` Action, except defaulting to detached mode. This will come in handy in the increasingly many cases I seem to experience of late where I want to use the detached mode without the price of adding a `with` section. Not a big price, but it accumulates. Signed-off-by: Johannes Schindelin <[email protected]> * README: document the `mxschmitt/action-tmate/detached` Action This "sub-"Action merely switches the default to `detached: true`. Which is so much more convenient than having to add a `with:` section _just_ for that mode. Signed-off-by: Johannes Schindelin <[email protected]> * ci(manual-detached-test): use the `./detached` "sub-Action" Signed-off-by: Johannes Schindelin <[email protected]> * ci(manual-detached-test): drop no-longer-needed setting We now limit access to the actor by default, iff the actor has a public SSH key registered in their GitHub profile. Signed-off-by: Johannes Schindelin <[email protected]> * ci(manual-test): stop mentioning the obsolete ubuntu-20.04 pool It has gone to the ~Google~GitHub Graveyard. Signed-off-by: Johannes Schindelin <[email protected]> * Add support for output * Add ssh to output * (feature) Add outputs to detached action as well * ci: verify that the `action.yml` files are in sync In mxschmitt#218, I added a convenient way to launch this Action in detached mode: `mxschmitt/action-tmate/detached@v3`. The way this is implemented is a copy/edited version of `action.yml` in the `detached/` subdirectory. This runs the danger of inadvertent divergences, as happened in mxschmitt#221 (which I caught in time and the contributor gracefully addressed). Let's add automation not only to update the file easily but also to cause a failure in the PR build with a helpful message suggesting how to fix the problem. Signed-off-by: Johannes Schindelin <[email protected]> * detached/action.yml: synchronize with `action.yml` There was a difference in whitespace, caught by the new step in `checkin.yml`. Signed-off-by: Johannes Schindelin <[email protected]> * ci: fix 'Verify that the project is built' The output of that step, if something goes wrong, claims that `dist/` is not up to date, but the build product is in `lib/`. Also, `git status -s` shows not only differences in the tracked files, but also untracked files (which should not exist at that stage). Let's avoid puzzling contributors when there are untracked files by logging the output of `git status -s`. Signed-off-by: Johannes Schindelin <[email protected]> * ci(manual-test): update list of runner images See https://github.com/actions/runner-images/blob/310e8e963731084df01bcbdbd5044a5ca7fc0c88/README.md#available-images. * ci(manual-test): convert from a matrix job to a single job With this change, the `manual-test` workflow accepts user input as to what runner OS or Docker image to run on. It is more useful this way, too, as I never encountered a situation where I would want to run this Action on multiple runners, having to log in concurrently into multiple tmate sessions, and I doubt that anyone else has encountered that situation, either. Signed-off-by: Johannes Schindelin <[email protected]> * Add a node.js script to update manual-test's `runs-on` options As I had suggested in mxschmitt#224 (comment), it would be good to have some sort of automation to update the ever-changing list of runner pools that are supported by GitHub. Signed-off-by: Johannes Schindelin <[email protected]> * ci(manual-test): update `runs-on` options Brought to you by the new `update-manual-test.js` script. Signed-off-by: Johannes Schindelin <[email protected]> * update-manual-test: special-case Windows/ARM64 runners For a little more than two weeks, as of time of writing, there are GitHub-hosted Windows/ARM64 runners (at long last!), announced here: https://github.blog/changelog/2025-04-14-windows-arm64-hosted-runners-now-available-in-public-preview/ These are not yet listed in the `runner-images` README, therefore we want to add them manually. Signed-off-by: Johannes Schindelin <[email protected]> * manual-test: install MSYS2 on Windows/ARM64 The Windows/ARM64 runners that are currently in public preview do not have MSYS2 installed by default, so let's do that. Signed-off-by: Johannes Schindelin <[email protected]> --------- Signed-off-by: Dave Lee <[email protected]> Signed-off-by: Loic Pottier <[email protected]> Signed-off-by: Johannes Schindelin <[email protected]> Co-authored-by: Vadim Peretokin <[email protected]> Co-authored-by: Dave Lee <[email protected]> Co-authored-by: Johannes Schindelin <[email protected]> Co-authored-by: Rui Chen <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Loic Pottier <[email protected]> Co-authored-by: jeremyd2019 <[email protected]> Co-authored-by: Max schwenk <[email protected]> Co-authored-by: Yukai Chou <[email protected]>
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 complex corporate setups, it is not uncommon that CI processes are designed to notify engineers at strategic times during lengthy workflows. To integrate
action-tmatein such a process, it is necessary to have vital information (such as the SSH address) at hand, to be able to, say, send a Slack message to the person who will most likely want to connect to the tmate session. This PR adds support for that, by providing said information via Action outputs.