Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use of system dependent path in install description results incorrect path in README #886

Closed
zmully opened this issue Jun 4, 2024 · 0 comments · Fixed by #887
Closed

Comments

@zmully
Copy link

zmully commented Jun 4, 2024

Describe the bug

The description for the install command uses the path variable config.dataDir which is system dependent:

static description = `Uses bundled npm executable to install plugins into <%= config.dataDir %>

This results in the (usually) incorrect path in the generated README.md file as the users path is different from the path in CI, is different than the path on macOS, etc.

This also causes our precommit checks to fail since the README.md file is updated with the local path, which won't match what was checked in, as the path contains the username of the last committer.

Ideally, this would be removed from the description, or excepted from the README generation, so that different systems don't result in changesets when the README.md is generated.

To Reproduce
Steps to reproduce the behavior:

  1. Generate readme on a linux system
  2. Generate readme on a macos system
  3. Compare the readmes, the diff will look like this:
-  Uses bundled npm executable to install plugins into /home/zmully/.local/share/px
+  Uses bundled npm executable to install plugins into /Users/zmully/.local/share/px

Expected behavior

README generation should not be system dependent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant