feat: modernize cli bootstrap and docs#2
Open
ss-o wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Modernizes the ZUnit CLI bootstrap path and refreshes the docs to point at the z-shell organization. Help/version/init flows can now run without revolver installed, zunit init --github-actions scaffolds a GitHub Actions workflow, and several stale URLs / messages are corrected. New focused tests cover the no-revolver flows and the new bootstrap output.
Changes:
- Move
--help,--version, andinithandling above therevolverdependency check insrc/zunit.zsh, and add a-g/--github-actionsflag to_zunit_initthat writes.github/workflows/zunit.yml. - Rewrite
README.md,contributing.md, andcode-of-conduct.mdto point at the Z-Shell organization, drop outdated package-manager recipes, and delegate to org-wide policy docs. - Fix stale strings (
Run \zulu init`→zunit init,supress→suppress, HTML report link/documentation link toz-shell/zunit) and addtests/cli.zunit/tests/reports.zunit` regression coverage.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/zunit.zsh | Parse -h/-v and dispatch init before requiring revolver; update missing-dependency URL. |
| src/commands/init.zsh | Add -g/--github-actions bootstrap, update Travis template's revolver/color URLs to zdharma. |
| src/commands/run.zsh | Correct the missing-config error from zulu init to zunit init. |
| src/reports/html.zsh | Update the documentation link in the HTML report header to z-shell/zunit. |
| zunit.zsh-completion | Fix supress → suppress typos and advertise the new -g/--github-actions flag. |
| tests/cli.zunit | New regression tests for the no-revolver CLI flows and GitHub Actions bootstrap. |
| tests/reports.zunit | New test asserting the HTML report template links to the maintained repo. |
| README.md | Rewrite for the Z-Shell org, drop unsupported install methods, refresh docs link. |
| contributing.md | Slim down to org-wide contributing guidance and a focused development workflow. |
| code-of-conduct.md | Replace the inlined Contributor Covenant with a pointer to the org-wide policy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sudo apt-get update | ||
| sudo apt-get install -yq zsh | ||
| mkdir -p .bin | ||
| curl -fsSL 'https://github.com/zunit-zsh/zunit/releases/download/v${zunit_version}/zunit' > .bin/zunit |
| @@ -72,13 +75,43 @@ allow_risky: false" | |||
| install: | |||
| - mkdir .bin | |||
| - curl -L https://github.com/zunit-zsh/zunit/releases/download/v$(_zunit_version)/zunit > .bin/zunit | |||
| echo " -v, --version Output version information and exit" | ||
| echo " -t, --travis Generate .travis.yml in project" | ||
| echo " -h, --help Output help text and exit" | ||
| echo " -v, --version Output version information and exit" |
Comment on lines
+12
to
+16
| PATH='/usr/bin:/bin' | ||
| run "$PWD/zunit" --version | ||
|
|
||
| assert "$state" equals 0 | ||
| assert "$output" same_as '0.8.2' |
Comment on lines
+27
to
+36
| @test 'report output without config points users to zunit init' { | ||
| local sandbox | ||
| sandbox="$(mktemp -d)" | ||
|
|
||
| cd "$sandbox" | ||
| run "$OLDPWD/zunit" --output-text | ||
|
|
||
| assert "$state" equals 1 | ||
| assert "$output" contains '.zunit.yml could not be found. Run `zunit init`' | ||
| } |
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
--help,--version, andinitflows to run withoutrevolverzunit init --github-actionsbootstrap supportVerification
./build.zshPATH="$tmpbin:$PATH" ./zunit --tap tests/cli.zunit tests/reports.zunit→ 8/8 passing with a temporary stubrevolverzsh -n src/zunit.zsh src/commands/init.zsh src/commands/run.zsh src/reports/html.zshgit diff --check