Repository navigation
docs: add guides for new machines, scripts and CI - #314
Merged
Merged
Conversation
- Set up a new machine: install, access to a private repository, init, deploy with a dry run first, the setup script, local files per project, a bootstrap script that needs no answers, and keeping the machine in sync. - Use configfile in scripts and CI: the option that replaces each question without a terminal, exit codes, output, and a GitHub Actions workflow that checks a dotfiles repository on every push by deploying it into a throwaway home folder with --dry-run. The commands, messages and exit codes shown were run for real without a terminal, including a dry run on a repository with invalid modules and an init from a checkout in detached HEAD, as in CI. The example workflow passes actionlint.
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
Adds two task-oriented guides to the documentation site. The tutorial covers a first repository on one machine; these pages cover what users do next.
Set up a new machine (
guides/new-machine.md)init, thenmodules statusand a--dry-runbefore deploying every module, what happens to the files already in place, and the setup script.--repo,--all,set -e).update, deploying new files, removing what the repository no longer deploys.Use configfile in scripts and CI (
guides/scripts-and-ci.md)scripts run), and output (scripts runkeeps stdout for the script;history --json).modules deploy --all --dry-run, which fails on invalid JSON, missing targets or refused targets. An optional matrix step runs the setup script on Linux and macOS.The home page links to the guides, and Upgrading from 0.3 now comes last in the Guides section.
Other Informations
deploy --localwith and without--force, a dry run on a repository where one module is valid and others aren't (it fails with exit code 1), and aninitfrom a checkout in detached HEAD, asactions/checkoutproduces for pull requests.actionlint. It setsHOMEthrough$GITHUB_ENVso that every following step uses the throwaway home folder.Testing:
pnpm docs:build, the site's type check andpnpm checkpass; every internal link and section anchor of the built site resolves.