mirror of
https://github.com/webfactory/ssh-agent.git
synced 2025-04-24 15:02:13 +00:00
Improve documentation on why we use os.userInfo()
(use correct syscall name) Co-authored-by: Matthias Pigulla <mp@webfactory.de>
This commit is contained in:
parent
e3f1a8e046
commit
72c0bfd31a
1 changed files with 3 additions and 2 deletions
5
paths.js
5
paths.js
|
@ -2,8 +2,9 @@ const os = require('os');
|
||||||
const core = require('@actions/core');
|
const core = require('@actions/core');
|
||||||
|
|
||||||
const defaults = (process.env['OS'] != 'Windows_NT') ? {
|
const defaults = (process.env['OS'] != 'Windows_NT') ? {
|
||||||
// Use getent() system call, since this is what ssh does; makes a difference in Docker-based
|
// We use os.userInfo() rather than os.homedir(), since it uses the getpwuid() system call to get the user's home directory (see https://nodejs.org/api/os.html#osuserinfooptions).
|
||||||
// Action runs, where $HOME is different from the pwent
|
// This mimics the way openssh derives the home directory for locating config files (see https://github.com/openssh/openssh-portable/blob/826483d51a9fee60703298bbf839d9ce37943474/ssh.c#L710);
|
||||||
|
// Makes a difference in Docker-based Action runs, when $HOME is different from what getpwuid() returns (which is based on the entry in /etc/passwd)
|
||||||
homePath: os.userInfo().homedir,
|
homePath: os.userInfo().homedir,
|
||||||
sshAgentCmdDefault: 'ssh-agent',
|
sshAgentCmdDefault: 'ssh-agent',
|
||||||
sshAddCmdDefault: 'ssh-add',
|
sshAddCmdDefault: 'ssh-add',
|
||||||
|
|
Loading…
Add table
Reference in a new issue