Repository navigation
docs: install configfile from the npm registry - #339
Merged
Merged
Conversation
Base automatically changed from
chore/merge-master-into-develop-2.0.0
to
develop
October 28, 2026 20:51
Versions 1.0.0 and later are published to npm, with provenance, so the install commands no longer need the GitHub release's address, nor a version updated at each release. The CI guide pins the major version.
mindsers
force-pushed
the
feature/docs-npm-registry
branch
from
October 28, 2026 20:53
7e4f50c to
75b3295
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
configfile installs your dotfiles from a git repository you own. It can be installed with a script that downloads a standalone binary, with Homebrew, or with npm.
The npm instructions installed the package from the GitHub release's address (
npm install --global https://github.com/mindsers/configfile/releases/download/2.0.0/configfile-2.0.0.tgz), and the installation page said thatnpm install --global configfile"still installs 0.3.1". That is no longer true: the release workflow publishes every release to npm, and the registry has had 1.0.0, 1.1.0 and now 2.0.0, with provenance (npm view configfile).So the documentation now uses the registry:
README.mdand the installation page:npm install --global configfile. The page says how to update, and that the npm package is the GitHub release's.tgzwith its provenance; the "not on the npm registry yet" note is removed.npm install --global configfile@2, so a dotfiles repository's CI keeps working until its owner chooses to move to a later major version, which may change what configfile accepts. One sentence says so.CONTRIBUTING.md: a release is published to npm, no longer "when it is turned on".A side effect: a release no longer has to update these addresses.
Other Informations
Review order:
docs/src/content/docs/getting-started/installation.md(the "With npm" section),docs/src/content/docs/guides/scripts-and-ci.md(the workflow and the sentence after it),README.md,CONTRIBUTING.md.Tests: documentation only. Lint and the docs build pass. Both commands install 2.0.0 in a throwaway folder: