Skip to content

docs: add third-party libraries to check update methods #5819

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 1 commit into from
Mar 31, 2025

Conversation

JoeshuTT
Copy link
Contributor

@JoeshuTT JoeshuTT commented Mar 30, 2025

Description

提供更加灵活的应用版本检查更新策略:version-polling
使用 http etage方案有缺陷,前端不可控。
不清楚作者大大对于“项目检查更新”这块功能安排,我的最初想法增加一个第三方扩展的选项,对项目有侵入性。
所以没有提交项目修改代码,只添加了文档使用实例。

效果:
PixPin_2025-03-30_13-46-46

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

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
    • Introduced a new guide section detailing how to integrate update notifications. Users are now informed on the installation and setup processes that enable the page to prompt for a refresh when a new update is available.

Copy link

changeset-bot bot commented Mar 30, 2025

⚠️ No Changeset found

Latest commit: aa664fd

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 Mar 30, 2025

Walkthrough

This PR updates the documentation by adding a new section that explains how to implement the third-party version-polling library for update checking. The section details installation via pnpm and demonstrates integration steps for projects such as apps/web-antd (e.g., in main.ts or app.vue). A code snippet is provided to set up createVersionPolling, including options for silent behavior in development mode and a callback that triggers a refresh notification when an update is detected.

Changes

File Summary
docs/.../check-updates.md Added a section on using the version-polling library for update checking, with installation instructions and a code snippet for integration.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant VP as VersionPolling Library
    participant UI as Notification System

    App->>VP: Initialize createVersionPolling(options)
    VP-->>App: Perform regular update checks
    VP->>App: Trigger callback on update detection
    App->>UI: Display update notification
    UI->>App: User accepts and refreshes
Loading

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • anncwb
  • vince292007

Poem

I'm a hopping rabbit, proud and fleet,
With version-polling, my code's complete.
Updates alert with a gentle cue,
So fresh and brisk, like morning dew.
Hop along and refresh to a brand-new beat! 🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c155c6 and aa664fd.

📒 Files selected for processing (1)
  • docs/src/guide/in-depth/check-updates.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/src/guide/in-depth/check-updates.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 (2)
docs/src/guide/in-depth/check-updates.md (2)

50-53: Documentation Section Addition: Third-Party Update Check

The new section titled "替换为第三方库检查更新方式" clearly introduces an alternative update checking mechanism using the version-polling library. The explanation is concise and highlights various strategies (chunkHash, version.json, Web Worker, etc.) which offer flexibility over the default etag approach.


58-93: Integration Code Sample: Clear and Functional

The provided TypeScript integration snippet for apps/web-antd is well-structured and demonstrates the use of createVersionPolling along with proper configuration:

  • The use of silent: import.meta.env.MODE === 'development' ensures that update checks are appropriately muted during development.
  • The onUpdate callback is neatly implemented with a dynamic key generation and the use of ant-design-vue for notifications.
  • Leveraging Vue’s h function for rendering the notification button is a good practice.

A few suggestions for further clarity:

  • Consider adding inline comments within the snippet to explain the roles of critical variables (e.g., the dynamic key and the self parameter) for newcomers to the code.
  • Optionally, a note on potential configuration prerequisites (for instance, any specific version requirements or extra steps needed for production usage) could enhance the documentation.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dbc0b7e and 2c155c6.

📒 Files selected for processing (1)
  • docs/src/guide/in-depth/check-updates.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (1)
docs/src/guide/in-depth/check-updates.md (1)

54-57: Installation Command Instruction

The bash code snippet for installing the version-polling library using pnpm add version-polling is clear and correct. It effectively communicates the installation step required before integrating the library into the project.

@JoeshuTT JoeshuTT force-pushed the feat/version-polling branch from 2c155c6 to aa664fd Compare March 30, 2025 06:35
@JoeshuTT JoeshuTT changed the title docs(@vben/docs): Add third-party libraries to check update methods docs: add third-party libraries to check update methods Mar 30, 2025
@jinmao88 jinmao88 merged commit 0e3abc2 into vbenjs:main Mar 31, 2025
4 of 6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 1, 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.

2 participants