29|周边:框架发布和维护也是重要的一环
叶剑峰
该思维导图由 AI 生成,仅供参考
你好,我是轩脉刃。
终于来到框架设计与完善的最后一节课了。在前面的章节中,我们基本上把框架的功能都开发完成了,但是这只是万里长征的第一步。一个工业级的 Web 框架一定是经过长时间千锤百炼的迭代升级的。在这门课编写完成的时候,我为 hade 框架锁定了 v 1.0.0 版本,后续我们会继续为框架增加更多的功能和特性。
那么随着框架的不断更新和升级,随之而来的问题就是如何为一个开源项目设计一套发布和使用机制,并且为每个发布版本维护一套准确的框架说明文档?这就是我们今天要讨论的内容。
版本
每个框架发布都需要有一个版本号,这个版本号如何定义,我们在前面的课程中已经不止一次提到过了,这里再正式说明一下。
所有开源软件的版本号基本上都遵循“语义化版本规范”的约定,这份语义化版本规范是由 Gravatars 创办者兼 GitHub 共同创办者 Tom Preston-Werner 所建立的,它定义了三段式的版本规范,格式如下:
我们使用的 Golang 语言项目也是基于这个规范来实现的。
主版本号代表如果做了不兼容的 API 修改。比如在你的项目中,原先提供的 A 方法要替换为 B 方法,所有的参数和返回值都已经变化了,你的使用方必须修改他的代码,这个变动就叫做“不兼容的 API 修改”。这个时候,主版本号就必须更新了。
公开
同步至部落
取消
完成
0/2000
荧光笔
直线
曲线
笔记
复制
AI
- 深入了解
- 翻译
- 解释
- 总结
本文详细介绍了在开发完框架后,发布和维护的重要性,并围绕版本规范、发布模式和文档维护等内容展开讨论。作者首先介绍了语义化版本规范,并说明了在Golang项目中如何遵循这个规范。接着,详细介绍了框架的发布模式,包括在GitHub上创建release版本以及使用者的安装和项目创建步骤。最后,讨论了框架文档的维护,提到了小型项目使用markdown编写文档,而大型项目则会开启官方网站来展示项目使用文档,并介绍了如何结合markdown编写和自动转化为HTML网站的工具vuepress。整篇文章内容丰富,为读者提供了全面的框架发布和维护知识。文章中还介绍了如何使用vuepress工具生成HTML文件,并将HTML文件部署到Web服务器中。最后,总结了hade框架的发布和文档维护的独特设计,以及框架的功能开发完毕和发布版本的信息。整体而言,本文内容涵盖了框架发布和维护的方方面面,对于开发者来说具有很高的参考价值。
仅可试看部分内容,如需阅读全部内容,请付费购买文章所属专栏
《手把手带你写一个 Web 框架》,新⼈⾸单¥59
《手把手带你写一个 Web 框架》,新⼈⾸单¥59
立即购买
© 版权归极客邦科技所有,未经许可不得传播售卖。 页面已增加防盗追踪,如有侵权极客邦将依法追究其法律责任。
登录 后留言
全部留言(3)
- 最新
- 精选
- 牛玉富最后一课了不应该没有留言啊,内容太丰富了,真的难以想象一个为一个课程花了多大精力。2022-01-132
- River大赞作者,是个需要反复学习的专栏,也是web 开发的工具包。2022-05-211
- lingege244➜ ~ go install github.com/gohade/hade@latest 请问Mac-Pro 环境下执行 会报错,该如何处理 github.com/erikdubbelboer/gspt: build constraints exclude all Go files in /mygo/pkg/mod/github.com/erikdubbelboer/gspt@v0.0.0-20210805194459-ce36a51283772023-10-17归属地:广东
收起评论