Skip to content

docs: install configfile from the npm registry - #339

Merged
mindsers merged 1 commit into
developfrom
feature/docs-npm-registry
Oct 28, 2026
Merged

mindsers merged 1 commit into
developfrom
feature/docs-npm-registry

Conversation

@mindsers

@mindsers mindsers commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

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 that npm 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.md and the installation page: npm install --global configfile. The page says how to update, and that the npm package is the GitHub release's .tgz with its provenance; the "not on the npm registry yet" note is removed.
  • The CI guide's workflow: 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:

(
  export HOME="$(mktemp -d)"
  for spec in configfile configfile@2; do
    prefix="$(mktemp -d)"
    npm install --global --prefix "$prefix" "$spec" >/dev/null && "$prefix/bin/configfile" --version   # 2.0.0
  done
)

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
mindsers force-pushed the feature/docs-npm-registry branch from 7e4f50c to 75b3295 Compare October 28, 2026 20:53
@mindsers
mindsers merged commit 8e488f8 into develop Oct 28, 2026
21 of 22 checks passed
@mindsers
mindsers deleted the feature/docs-npm-registry branch October 28, 2026 22:42
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 this pull request may close these issues.

1 participant