Skip to content

Commit

Permalink
Improve documentation on why we use os.userInfo()
Browse files Browse the repository at this point in the history
(use correct syscall name)
  • Loading branch information
janopae committed Jan 8, 2025
1 parent e3f1a8e commit 6714fba
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions paths.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ const os = require('os');
const core = require('@actions/core');

const defaults = (process.env['OS'] != 'Windows_NT') ? {
// Use getent() system call, since this is what ssh does; makes a difference in Docker-based
// Action runs, where $HOME is different from the pwent
// 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).
// 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,
sshAgentCmdDefault: 'ssh-agent',
sshAddCmdDefault: 'ssh-add',
Expand Down

0 comments on commit 6714fba

Please sign in to comment.