Skip to content

docs: revise Netlify deployment update instructions#1002

Merged
imaegoo merged 3 commits into
twikoojs:mainfrom
aicorein:main
Jun 26, 2026
Merged

docs: revise Netlify deployment update instructions#1002
imaegoo merged 3 commits into
twikoojs:mainfrom
aicorein:main

Conversation

@aicorein

@aicorein aicorein commented Jun 26, 2026 •
edited by sourcery-ai Bot
Loading

Copy link
Copy Markdown
Contributor

Updated instructions for modifying package.json for Netlify deployment, including version synchronization with twikoo-vercel.

Fixes: #1001

由 Sourcery 提供的总结

文档：

  • 更新 Netlify 部署文档，展示如何在 package.json 中为 twikoo-netlify 和 twikoo-vercel 编辑并保持版本一致。
Original summary in English

Summary by Sourcery

Documentation:

  • Update Netlify deployment documentation to show editing package.json for twikoo-netlify and twikoo-vercel with matching versions.

@aicorein
docs: revise Netlify deployment update instructions
35c1f0a 
- Updated instructions for modifying package.json for Netlify deployment, including version synchronization with twikoo-vercel.
@sourcery-ai

sourcery-ai Bot commented Jun 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
审阅者指南（在小型 PR 上默认折叠）

审阅者指南

更新了 Netlify 部署文档，明确说明在 package.json 中必须同时更新 twikoo-netlify 和 twikoo-vercel 的依赖版本，并相应调整了逐步操作说明。

更新后的 Netlify 部署更新步骤流程图

flowchart TD
  A[Edit package.json in twikoo-netlify repo] --> B[Set dependency twikoo-netlify to new version]
  B --> C[Set dependency twikoo-vercel to same new version]
  C --> D[Commit changes]
  D --> E[Netlify deployment auto-triggers]
Loading

文件级改动

变更 详情 文件
明确 Netlify 部署更新步骤，保证在 package.json 中 twikoo-netlify 和 twikoo-vercel 版本保持同步。
  • 将单一依赖更新说明，替换为指导编辑 package.json，并说明 twikoo-netlify 复用 twikoo-vercel 的实现
  • 添加了一个 JSON 代码片段，展示 twikoo-netlify 和 twikoo-vercel 依赖被设置为相同新版本占位符的示例
  • 调整了编号步骤，使提交更改现在作为编辑 package.json 之后的独立步骤
 docs/update.md

与关联 Issue 的对照评估

Issue 目标 是否满足 说明
#1001 更新 Netlify 部署更新文档，使其解释正确的更新方式：在 package.json 中同步更新 twikoo-netlify 和 twikoo-vercel 的版本（而不是只更新 twikoo-netlify）。 ✅

可能相关的 Issue

技巧与命令

与 Sourcery 交互

  • 触发新评审： 在 pull request 中评论 @sourcery-ai review。
  • 继续讨论： 直接回复 Sourcery 的评审评论。
  • 从评审评论生成 GitHub Issue： 在评审评论下回复，请求 Sourcery 从该评论创建一个 issue。你也可以直接回复 @sourcery-ai issue 来从该评论创建 issue。
  • 生成 pull request 标题： 在 pull request 标题的任意位置写上 @sourcery-ai 即可随时生成标题。你也可以在 pull request 中评论 @sourcery-ai title 来（重新）生成标题。
  • 生成 pull request 摘要： 在 pull request 正文任意位置写上 @sourcery-ai summary，即可在你想要的位置生成 PR 摘要。你也可以在 pull request 中评论 @sourcery-ai summary 来（重新）生成摘要。
  • 生成审阅者指南： 在 pull request 中评论 @sourcery-ai guide，即可随时（重新）生成审阅者指南。
  • 批量解决所有 Sourcery 评论： 在 pull request 中评论 @sourcery-ai resolve，即可将所有 Sourcery 评论标记为已解决。如果你已经处理完所有评论且不想再看到它们，这会很有用。
  • 批量忽略所有 Sourcery 评审： 在 pull request 中评论 @sourcery-ai dismiss，即可忽略所有现有的 Sourcery 评审。特别适合你想从头开始新一轮评审的情况——别忘了再评论 @sourcery-ai review 来触发新的评审！

自定义你的使用体验

访问你的 控制面板 以：

  • 启用或禁用评审功能，例如 Sourcery 自动生成的 pull request 摘要、审阅者指南等。
  • 更改评审语言。
  • 添加、移除或编辑自定义评审指令。
  • 调整其他评审设置。

获取帮助

Original review guide in English
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates Netlify deployment documentation to clarify that both twikoo-netlify and twikoo-vercel dependency versions must be updated together in package.json, and adjusts the step-by-step instructions accordingly.

Flow diagram for updated Netlify deployment update steps

flowchart TD
  A[Edit package.json in twikoo-netlify repo] --> B[Set dependency twikoo-netlify to new version]
  B --> C[Set dependency twikoo-vercel to same new version]
  C --> D[Commit changes]
  D --> E[Netlify deployment auto-triggers]
Loading

File-Level Changes

Change Details Files
Clarified Netlify deployment update steps to keep twikoo-netlify and twikoo-vercel versions in sync in package.json.
  • Replaced single dependency update instruction with guidance to edit package.json considering twikoo-netlify reuses twikoo-vercel implementation
  • Added a JSON snippet showing twikoo-netlify and twikoo-vercel dependencies set to the same new version placeholder
  • Adjusted the numbered steps so committing changes is now a separate step after editing package.json
 docs/update.md

Assessment against linked issues

Issue Objective Addressed Explanation
#1001 Update the Netlify deployment update documentation so that it explains the correct way to update by synchronizing both twikoo-netlify and twikoo-vercel versions in package.json (instead of only updating twikoo-netlify). ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai Bot reviewed Jun 26, 2026
View reviewed changes

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - 我发现了 1 个问题，并给出了一些总体反馈：

  • 建议明确说明用户应该在哪里找到 <new version> 的值（例如在 npm 包页面，或 twikoo-vercel 仓库的最新发布版本中），以免他们不确定应该复制哪一个版本字符串。
给 AI Agent 的提示 
Please address the comments from this code review:

## Overall Comments
- Consider making it explicit where users should find the `<new version>` value (e.g., from the npm package page or the twikoo-vercel repository’s latest release) so they aren’t unsure which version string to copy.

## Individual Comments

### Comment 1
<location path="docs/update.md" line_range="49" />
<code_context>
 ## 针对 Netlify 部署的更新方式

 1. 登录 Github，找到部署时 fork 到自己账号下的名为 twikoo-netlify 的仓库
-2. 打开 package.json，点击编辑
-3. 将 `"twikoo-netlify": "latest"` 其中的 `latest` 修改为最新版本号。点击 Commit changes
</code_context>
<issue_to_address>
**nitpick (typo):** Consider correcting the product name from "Github" to "GitHub".

Using the official capitalization will keep the documentation polished and consistent with the service’s branding.

```suggestion
1. 登录 GitHub，找到部署时 fork 到自己账号下的名为 twikoo-netlify 的仓库
```
</issue_to_address>
Sourcery 对开源项目免费使用——如果你觉得我们的代码审查对你有帮助，欢迎分享 ✨
帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的代码审查。
Original comment in English

Hey - I've found 1 issue, and left some high level feedback:

  • Consider making it explicit where users should find the <new version> value (e.g., from the npm package page or the twikoo-vercel repository’s latest release) so they aren’t unsure which version string to copy.
Prompt for AI Agents 
Please address the comments from this code review:

## Overall Comments
- Consider making it explicit where users should find the `<new version>` value (e.g., from the npm package page or the twikoo-vercel repository’s latest release) so they aren’t unsure which version string to copy.

## Individual Comments

### Comment 1
<location path="docs/update.md" line_range="49" />
<code_context>
 ## 针对 Netlify 部署的更新方式

 1. 登录 Github，找到部署时 fork 到自己账号下的名为 twikoo-netlify 的仓库
-2. 打开 package.json，点击编辑
-3. 将 `"twikoo-netlify": "latest"` 其中的 `latest` 修改为最新版本号。点击 Commit changes
</code_context>
<issue_to_address>
**nitpick (typo):** Consider correcting the product name from "Github" to "GitHub".

Using the official capitalization will keep the documentation polished and consistent with the service’s branding.

```suggestion
1. 登录 GitHub，找到部署时 fork 到自己账号下的名为 twikoo-netlify 的仓库
```
</issue_to_address>
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/update.md Outdated
aicorein and others added 2 commits June 26, 2026 17:43
@aicorein
Update instructions for Netlify deployment
a3841c7 
Clarify instructions for updating version numbers in package.json.
@imaegoo @sourcery-ai
Apply suggestion from @sourcery-ai[bot]
47b9e1d 
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@imaegoo imaegoo merged commit aa8b260 into twikoojs:main Jun 26, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

netlify 平台的云函数更新问题 & 解决方法

2 participants

@aicorein @imaegoo