From b2d386f4094c938403a62432d96addc8cd6e8591 Mon Sep 17 00:00:00 2001
From: Cory Miller <13227161+cory-miller@users.noreply.github.com>
Date: Thu, 18 Apr 2024 14:55:49 +0000
Subject: [PATCH] Update docs with param
---
README.md | 3 +++
action.yml | 3 +++
2 files changed, 6 insertions(+)
diff --git a/README.md b/README.md
index bfecf46..31b97c3 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,9 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# the input `ssh-known-hosts` to configure additional hosts.
# Default: true
ssh-strict: ''
+
+ # The user to use when connecting to the remote SSH host. By default 'git' is used.
+ ssh-user: ''
# Whether to configure the token or SSH key with the local git config
# Default: true
diff --git a/action.yml b/action.yml
index 5aa90a7..e800a51 100644
--- a/action.yml
+++ b/action.yml
@@ -45,6 +45,9 @@ inputs:
and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to
configure additional hosts.
default: true
+ ssh-user:
+ description: >
+ The user to use when connecting to the remote SSH host. By default 'git' is used.
persist-credentials:
description: 'Whether to configure the token or SSH key with the local git config'
default: true