Skip to content
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

refactor: improve version number management #2943

Merged
merged 7 commits into from
Nov 13, 2024

Conversation

dongzhenye
Copy link
Contributor

@dongzhenye dongzhenye commented Nov 10, 2024

已知问题

  1. 版本号管理不规范

    • 版本号直接写在环境变量中,容易出错
    • 多处维护版本号,可能不一致
  2. 环境变量管理存在安全隐患

    • .env.local 被错误地加入版本控制
    • 敏感信息可能被泄露
    • 本地配置与代码库混合

解决方案

  1. 将版本号管理从 .env.local 迁移到 package.json

    • 统一从 package.json 读取版本号
    • 使用 IIFE 优雅处理版本号获取逻辑
    • 保持向后兼容,支持环境变量覆盖
  2. 规范配置文件的管理

    • 移除 .env.local 从版本控制
    • 提供 .env.example 的示例说明
    • 更新 .gitignore 配置

改动收益

  1. 更规范的版本管理

    • 统一从 package.json 读取
    • 保持与 npm 生态一致
    • 减少人为错误
  2. 更好的开发体验

    • 清晰的配置说明
    • 完整的示例配置
    • 更好的错误处理

具体改动

  1. blog.config.js

    • 移除原有的静态版本号配置
    • 在文件末尾添加动态版本号获取逻辑
    • 保持向后兼容,优先使用环境变量
    • 添加错误处理和默认值
  2. .env.local.env.example.gitignore

    • 从代码库中移除 .env.local 文件
    • 添加 .env.example 示例
    • 确保不会被意外提交
  3. CONTRIBUTING.md

    • 添加环境变量配置说明
    • 说明配置优先级

测试确认

  • 本地开发环境测试通过
  • 生产环境构建测试通过
  • 版本号正确显示
  • 环境变量配置正常工作

Copy link

vercel bot commented Nov 10, 2024

@dongzhenye is attempting to deploy a commit to the tangly1024's projects Team on Vercel.

A member of the Team first needs to authorize it.

@dongzhenye dongzhenye changed the title refactor: improve version management from env to package.jsonFeat/version management refactor: improve version no. management from env to package.json Nov 10, 2024
@dongzhenye dongzhenye changed the title refactor: improve version no. management from env to package.json refactor: improve version number management Nov 10, 2024
@tangly1024
Copy link
Owner

感谢您为项目提交的PR!🎉

您在解决版本号管理和配置文件安全性方面做出了非常有价值的改进。通过迁移版本号管理到package.json并.env.local并.env.example的

具体来说,尤其是添加动态版本号获取逻辑和详细的错误处理,为开发者提供了更好的开发体验。这种举措的优化让项目更加规范、可靠,也非常符合社区的最佳实践。

感谢您在细节方面的和改进!我会进一步审核代码,尽快合并此功能,有任何问题会及时沟通。

再次感谢您的贡献!期待您未来更精彩的创作!

@tangly1024 tangly1024 merged commit 17ff870 into tangly1024:main Nov 13, 2024
3 of 6 checks passed
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.

2 participants