gh-pages: The "path" argument must be of type string. Received type undefined

I’m currently getting this error when I try to use gh-pages:

The "path" argument must be of type string. Received type undefined

There’s a previous issue that’s similar to this (#308) and I saw that it was already fixed in the latest versions. I’m currently using gh-pages@2.2.0. My node version is v12.7.0 and my npm version is 6.10.0.

About this issue

  • Original URL
  • State: closed
  • Created 6 years ago
  • Reactions: 24
  • Comments: 15 (1 by maintainers)

Commits related to this issue

Most upvoted comments

Is anyone else getting the same error?

I am getting the same error. I dived into the code and I think I found the issue.

It´s on index.js:116.

  const clone = path.join(getCacheDir(), filenamify(repo));

The getCacheDir returns undefined in my case. Diving deeper, I found out it uses the find-cache-dir package, which has the following comment on the code:

Finds the cache directory using the supplied options.
 * The algorithm tries to find a `package.json` file, searching every parent directory of the `cwd` specified
 * (or implied from other options). It returns a `string` containing the absolute path to the cache directory,
 * or `undefined` if `package.json` was never found or if the `node_modules` directory is unwritable.

I don’t have a package.json file in my project. that´s why I think I am getting undefined.

This only happens on 3.1.0. 3.0.0 works fine,

I was getting this error after the 3.1.0 update. Rolled back to 3.0.0 and everything worked OK.

What solved it for us was just running a touch package.json prior to executing gh-pages in our CI/CD pipeline, not an elegant solution but it did work for us.

Still getting this error! Trying to publish without a package.json breaks it.

Still getting the same issue any idea why??

reading the release notes for 3.1.0

The cache directory used by gh-pages is now node_modules/.cache/gh-pages. If you want to use a different location, set the CACHE_DIR environment variable.

perhaps this issue can be solved by making a new (temporary) dir and passing it to a CACHE_DIR env variable.

Adding --dist . fixed the error for me.


I was getting this error with gh-pages 5.0.0, whether running via npm script, npx, or node ./node_modules/gh-pages/bin/gh-pages.js, with or without arguments, with package.json present:

npx gh-pages --src "{index.html,built,lib,tabs,impulses}/**/*"
gh-pages --src "{index.html,built,lib,tabs,impulses}"
gh-pages
node ./node_modules/gh-pages/bin/gh-pages.js --src "{index.html,built,lib,tabs,impulses}"
mkdir -p .gh-pages-cache && CACHE_DIR=.gh-pages-cache gh-pages --src "{index.html,built,lib,tabs,impulses}"
mkdir -p .gh-pages-cache && CACHE_DIR=$(realpath .gh-pages-cache) gh-pages --src "{index.html,built,lib,tabs,impulses}"

Debugging this with VS Code launch.json…

{
	"version": "0.2.0",
	"configurations": [
		{
			"type": "node",
			"request": "launch",
			"name": "Debug gh-pages",
			"skipFiles": [
				"<node_internals>/**"
			],
			"program": "./node_modules/gh-pages/bin/gh-pages.js",
			"outFiles": [
				"${workspaceFolder}/**/*.js"
			]
		}
	]
}

I found that was failing here:

function publish(config) {
  return new Promise((resolve, reject) => {
    const basePath = path.resolve(process.cwd(), program.dist);

program.dist is undefined

By the way, this sort of error would be easier to track down if it logged the err.stack instead of err.message here. If there are other errors where only the message is desired, treat them as a special case.