Skip to content

docs: document create-rsbuild --no-git option - #8239

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-create-rsbuild-no-git
Aug 9, 2026
Merged

chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-create-rsbuild-no-git

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

Summary

create-rsbuild now initializes a Git repository by default, but the quick-start guide still asks users to run git init and omits the --no-git opt-out from its CLI reference. This PR updates the English and Chinese guides to describe the default behavior, remove the stale manual step, and document --no-git.

Related Links

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying rsbuild with  Cloudflare Pages  Cloudflare Pages

Latest commit: dec3de1
Status: ✅  Deploy successful!
Preview URL: https://4fce898f.rsbuild-v2.pages.dev
Branch Preview URL: https://chenjiahan-docs-create-rsbui.rsbuild-v2.pages.dev

View logs

@chenjiahan
chenjiahan merged commit e0e6a33 into main Aug 9, 2026
8 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-create-rsbuild-no-git branch August 9, 2026 13:33

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dec3de1aa1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


Follow the prompts to choose options, such as whether to add optional tools like TypeScript and ESLint.

By default, the scaffold initializes a Git repository in the generated project. Pass `--no-git` to skip Git initialization.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Show the npm argument separator for --no-git

For the primary npm command shown immediately above, appending the flag as npm create rsbuild@latest --no-git does not pass it to create-rsbuild; npm consumes it as its own git=false configuration. npm's bundled npm-init documentation under “Forwarding additional options” explicitly maps initializer arguments using npm init foo -- --hello, so users following this text will still get a Git repository. Show the package-manager-specific invocation—npm create rsbuild@latest -- --no-git for npm—and make the same clarification in the mirrored Chinese text.

Useful? React with 👍 / 👎.

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