Skip to content

docs(settings): 完善 生产环境动态配置 步骤 #6297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2025

Conversation

wyc001122
Copy link
Contributor

@wyc001122 wyc001122 commented May 28, 2025

Description

完善 生产环境动态配置

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • Documentation
    • Improved formatting and clarity in the environment variables section.
    • Added a detailed example demonstrating how to extend dynamic configuration using environment variables, including support for additional configuration items.

Sorry, something went wrong.

Copy link

changeset-bot bot commented May 28, 2025

⚠️ No Changeset found

Latest commit: 8e09289

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

The documentation was updated to fix formatting and provide a new example illustrating how to extend the useAppConfig hook to support additional dynamic configuration variables, specifically demonstrating the inclusion of VITE_GLOB_OTHER_API_URL in addition to VITE_GLOB_API_URL. The example covers both development and production environments.

Changes

File(s) Change Summary
docs/src/en/guide/essentials/settings.md,
docs/src/guide/essentials/settings.md
Fixed formatting in a tip and added a detailed example for extending useAppConfig with new config items

Suggested reviewers

  • mynetfan
  • anncwb

Poem

A hop and a skip through settings anew,
Now configs are flexible—just add a few!
With useAppConfig extended, the docs show the way,
For devs and for prod, new URLs in play.
🥕 Cheers to more options, the rabbit will say!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/src/guide/essentials/settings.md (2)

24-24: Remove duplicate “的” in the tip.
The phrase “以 VITE_GLOB_* 开头的的变量” contains a duplicated “的”. It should read “以 VITE_GLOB_* 开头的变量” for clarity.


142-159: Enhance example by handling missing config values.
The code snippet correctly demonstrates extracting VITE_GLOB_OTHER_API_URL. Consider adding a fallback or type guard to avoid runtime undefined errors when the environment variable is absent, for example:

const { VITE_GLOB_API_URL, VITE_GLOB_OTHER_API_URL = '' } = config;
docs/src/en/guide/essentials/settings.md (1)

143-160: Optional: remind to clear cache after updates.
The code example is spot-on. You might add a note reminding readers to clear their browser cache or CDN cache after modifying _app.config.js to ensure the new values take effect.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f31360b and 9ebab97.

📒 Files selected for processing (2)
  • docs/src/en/guide/essentials/settings.md (2 hunks)
  • docs/src/guide/essentials/settings.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (3)
docs/src/guide/essentials/settings.md (1)

140-141: Approve addition of the new bullet for use-app-config.ts.
The instruction clearly shows where to update the hook to include additional variables.

docs/src/en/guide/essentials/settings.md (2)

24-24: Approve clarified packaging tip.
The updated sentence accurately explains that VITE_GLOB_* variables are added to _app.config.js during packaging.


141-141: Approve bullet for modifying use-app-config.ts.
The new instruction succinctly guides users on where to add their custom dynamic config.

@jinmao88 jinmao88 merged commit 78c3c9d into vbenjs:main Jun 2, 2025
13 checks passed
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 4, 2025
…into web

* 'main' of https://github.com/baohaojie123/vue-vben-admin:
  types: 扩展user-dropdown组件的menus类型,支持iconify (vbenjs#6283)
  fix: resolve onClosed method failure in connectedComponent of useVbenModal (vbenjs#6309)
  fix: 修复使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 (vbenjs#6310)
  fix:  When defaultHomePage is inconsistent with user.homePath, the pa… (vbenjs#6299)
  docs(settings): 完善'生产环境动态配置'步骤 (vbenjs#6297)
  fix: alert width fixed in small  screen (vbenjs#6312)
  style: fix lint error (vbenjs#6298)
  feat: support for hybrid permission access control mode (vbenjs#6294)
  fix: fix table-title slot not work (vbenjs#6295)

# Conflicts:
#	docs/src/en/guide/in-depth/access.md
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 11, 2025
* 'main' of https://github.com/baohaojie123/vue-vben-admin: (35 commits)
  chore: release 5.5.7
  feat: improve vbenCheckButtonGroup (vbenjs#6329)
  types: 扩展user-dropdown组件的menus类型,支持iconify (vbenjs#6283)
  fix: resolve onClosed method failure in connectedComponent of useVbenModal (vbenjs#6309)
  fix: 修复使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 (vbenjs#6310)
  fix:  When defaultHomePage is inconsistent with user.homePath, the pa… (vbenjs#6299)
  docs(settings): 完善'生产环境动态配置'步骤 (vbenjs#6297)
  fix: alert width fixed in small  screen (vbenjs#6312)
  style: fix lint error (vbenjs#6298)
  feat: support for hybrid permission access control mode (vbenjs#6294)
  fix: fix table-title slot not work (vbenjs#6295)
  fix: Update index.ts (vbenjs#6268)
  fix: reset slider-captcha after login failed (vbenjs#6275)
  fix: json-bigint parse used in vxeTable (vbenjs#6271)
  fix: repair the unexpected form default value (vbenjs#5567)
  feat: optimize logo display (vbenjs#6267)
  feat: improve check updates (vbenjs#6257)
  feat: enhances compatibility with APIs returning large numeric values (vbenjs#6250)
  fix: component Input is not registered when initialize page (vbenjs#6246)
  feat: ellipsis text automatically displays tooltip based on ellipsis (vbenjs#6244)
  ...

# Conflicts:
#	apps/web-naive/src/adapter/form.ts
#	apps/web-naive/src/bootstrap.ts
#	docs/src/components/common-ui/vben-ellipsis-text.md
#	docs/src/en/guide/in-depth/access.md
#	docs/src/guide/essentials/build.md
#	docs/src/guide/essentials/route.md
@github-actions github-actions bot locked and limited conversation to collaborators Jul 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants