Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` #154

DilumAluthge · 2022-12-01T04:59:06Z

On my self-hosted Windows runners, the git, ssh-agent, and ssh-add commands are not located in the locations that are currently hard-coded in paths.js.

With this PR, I am able to get this action to work on my runners as follows:

- uses: webfactory/ssh-agent@...
  with:
    ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
    git-cmd: git
    ssh-agent-cmd: ssh-agent
    ssh-add-cmd: ssh-add

…ssh-add`

DilumAluthge · 2022-12-12T04:59:05Z

@mpdude Could you review this?

DilumAluthge · 2023-01-05T22:14:14Z

Bump @mpdude

DilumAluthge · 2023-01-13T06:40:25Z

Bump @mpdude

mpdude · 2023-01-13T20:10:21Z

LGTM, thanks for the contribution!

For completeness, could you also please document the new inputs at https://github.com/webfactory/ssh-agent#action-inputs?

thanks

DilumAluthge · 2023-01-14T12:53:05Z

For completeness, could you also please document the new inputs at https://github.com/webfactory/ssh-agent#action-inputs?

Done!

DilumAluthge · 2023-01-26T04:30:31Z

Bump @mpdude

index.js

sebastiankugler · 2023-01-27T07:22:02Z

@mpdude can we merge this? Looks good to me.

mpdude · 2023-01-27T17:09:32Z

Thanks for your contribution, and sorry for the delay.

DilumAluthge · 2023-01-28T01:34:10Z

No worries, thanks for merging!

And thank you @mpdude and @sebastiankugler for the reviews!

Follow-up to #154

Bring `post` actions step into consistency with `main` for changes introduced in webfactory#154 Without this change, `sshAgentCmd` is undefined when passed to `execFileSync()` and cleanup is never successful.

Bring `post` actions step into consistency with `main` for changes introduced in webfactory#154 Without this change, `sshAgentCmd` is undefined when passed to `execFileSync()` during `cleanup` and `post` is never successful.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [webfactory/ssh-agent](https://togithub.com/webfactory/ssh-agent) | action | minor | `v0.5.3` -> `v0.8.0` | --- ### Release Notes <details> <summary>webfactory/ssh-agent (webfactory/ssh-agent)</summary> ### [`v0.8.0`](https://togithub.com/webfactory/ssh-agent/releases/tag/v0.8.0): SSH host keys no longer managed – read below 👇 [Compare Source](https://togithub.com/webfactory/ssh-agent/compare/v0.7.0...v0.8.0) Starting with this release, this action no longer writes GitHub's SSH host keys into the `known_hosts` SSH config file upon start. GitHub changed their host keys on short notice this morning, see https://github.blog/2023-03-23-we-updated-our-rsa-ssh-host-key/. We took this as an opportunity to stop maintaining GH SSH keys in the code shipped with this action ([#171](https://togithub.com/webfactory/ssh-agent/issues/171)). What you need to do: - On GitHub hosted runners, nothing. ✔︎ These runners ship with SSH host keys (for `github.com`) maintained by directly by GitHub. - On self-hosted runners, review and fix your SSH `known_hosts` file: - First, you'll find it bloated with redundant entries for `github.com`, as described in [#106](https://togithub.com/webfactory/ssh-agent/issues/106). Remove these entries. - Review https://github.blog/2023-03-23-we-updated-our-rsa-ssh-host-key/. You probably removed the old (invalid) SSH key in the previous step. - Configure GitHub's current SSH keys as documented on https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints - As long as versions before `v0.8.0` of this action here are run on the self-hosted runner, the old entries will come back. Keep an eye on it, possibly you'll have to rinse & repeat. ##### Other code changes in this release - Update to `actions/checkout@v3` by [@mpdude](https://togithub.com/mpdude) in [webfactory/ssh-agent#143 - Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` by [@DilumAluthge](https://togithub.com/DilumAluthge) in [webfactory/ssh-agent#154 ##### New Contributors - [@prhiggins](https://togithub.com/prhiggins) made their first contribution in [webfactory/ssh-agent#153 - [@kjarkur](https://togithub.com/kjarkur) made their first contribution in [webfactory/ssh-agent#147 - [@DilumAluthge](https://togithub.com/DilumAluthge) made their first contribution in [webfactory/ssh-agent#154 **Full Changelog**: webfactory/ssh-agent@v0.7.0...v0.8.0 ### [`v0.7.0`](https://togithub.com/webfactory/ssh-agent/blob/HEAD/CHANGELOG.md#v070-2022-10-19) [Compare Source](https://togithub.com/webfactory/ssh-agent/compare/v0.6.0...v0.7.0) ##### Added - Add the `log-public-key` input that can be used to turn off logging key identities ([#122](https://togithub.com/webfactory/ssh-agent/issues/122)) ##### Fixed - Fix path to `git` binary on Windows, assuming GitHub-hosted runners ([#136](https://togithub.com/webfactory/ssh-agent/issues/136), [#137](https://togithub.com/webfactory/ssh-agent/issues/137)) - Fix a nonsensical log message ([#139](https://togithub.com/webfactory/ssh-agent/issues/139)) ### [`v0.6.0`](https://togithub.com/webfactory/ssh-agent/blob/HEAD/CHANGELOG.md#v060-2022-10-19) [Compare Source](https://togithub.com/webfactory/ssh-agent/compare/v0.5.4...v0.6.0) ##### Changed - Update the version of Node used by the action from 12 to 16 (https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/). ### [`v0.5.4`](https://togithub.com/webfactory/ssh-agent/blob/HEAD/CHANGELOG.md#v054-2021-11-21) [Compare Source](https://togithub.com/webfactory/ssh-agent/compare/v0.5.3...v0.5.4) ##### Fixed - Update changed GitHub Host Keys ([#102](https://togithub.com/webfactory/ssh-agent/issues/102), [#101](https://togithub.com/webfactory/ssh-agent/issues/101)) ##### Changed - Various documentation (README) improvements and additions - Change logging to more precisely state that *public* keys are being printed </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Bring `post` actions step into consistency with `main` for changes introduced in webfactory#154 Without this change, `sshAgentCmd` is undefined when passed to `execFileSync()` during `cleanup` and `post` is never successful.

DilumAluthge changed the title ~~Allow the user to override the commands for git, ssh-agent, and ssh-add~~ [WIP] Allow the user to override the commands for git, ssh-agent, and ssh-add Dec 1, 2022

Allow the user to override the commands for git, ssh-agent, and `…

1d64dd4

…ssh-add`

DilumAluthge marked this pull request as ready for review December 1, 2022 05:21

DilumAluthge changed the title ~~[WIP] Allow the user to override the commands for git, ssh-agent, and ssh-add~~ Allow the user to override the commands for git, ssh-agent, and ssh-add Dec 1, 2022

Document the new workflow inputs in the README

50282a7

Fix a typo in the README

01b9820

sebastiankugler reviewed Jan 26, 2023

View reviewed changes

index.js Outdated Show resolved Hide resolved

Add missing trailing semicolons

6144f4b

mpdude merged commit 6f828cc into webfactory:master Jan 27, 2023

DilumAluthge deleted the dpa/windows-ssh-agent-path branch January 27, 2023 23:03

DilumAluthge mentioned this pull request Jan 28, 2023

Run npm run build and check in the results #159

Merged

sebastiankugler pushed a commit that referenced this pull request Jan 28, 2023

Add missing semicolons (#159)

ea17a05

Follow-up to #154

tkalus mentioned this pull request May 23, 2023

fix: Add Cmd Default/Input support to cleanup #183

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` #154

Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` #154

DilumAluthge commented Dec 1, 2022 •

edited

DilumAluthge commented Dec 12, 2022

DilumAluthge commented Jan 5, 2023

DilumAluthge commented Jan 13, 2023

mpdude commented Jan 13, 2023

DilumAluthge commented Jan 14, 2023

DilumAluthge commented Jan 26, 2023

sebastiankugler commented Jan 27, 2023

mpdude commented Jan 27, 2023

DilumAluthge commented Jan 28, 2023

Allow the user to override the commands for git, ssh-agent, and ssh-add #154

Allow the user to override the commands for git, ssh-agent, and ssh-add #154

Conversation

DilumAluthge commented Dec 1, 2022 • edited

DilumAluthge commented Dec 12, 2022

DilumAluthge commented Jan 5, 2023

DilumAluthge commented Jan 13, 2023

mpdude commented Jan 13, 2023

DilumAluthge commented Jan 14, 2023

DilumAluthge commented Jan 26, 2023

sebastiankugler commented Jan 27, 2023

mpdude commented Jan 27, 2023

DilumAluthge commented Jan 28, 2023

Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` #154

Allow the user to override the commands for `git`, `ssh-agent`, and `ssh-add` #154

DilumAluthge commented Dec 1, 2022 •

edited