让用户知道你的Github分叉不再被维护的最佳方式(即它已被合并)?

时间:2013-12-19 00:12:47

标签: ruby github rubygems bundler

三个月前,我为一个rubygem分叉了一个github存储库并添加了一些功能。相当多的人配置他们的Rails应用程序从我的github存储库加载该gem。昨天,作者合并了我的作品并发布了一个新的宝石。

我想通知那些继续从我的github回购中撤回他们应该切换回主要宝石的人。

我尝试在我的gemspec版本中添加'post_install_message',但捆绑包显然不会将其用于从路径或github加载的gems。

我可以修改代码以在日志文件中打印警告,但这感觉很麻烦。

我可以更新README,但这假设人们实际上会在github.com上阅读它。

想知道这种事情是否有良好/标准/首选方法?

编辑:嗯,这足以让我烦恼,我提交了一个拉取请求,将此功能添加到捆绑包中,用于通过git或:path包含的宝石。我们会看到会发生什么:)

更新:耶! https://github.com/bundler/bundler/commit/f876162b3d067ba5a3522b60e75cf13a19124f9c

2 个答案:

答案 0 :(得分:1)

更新自述文件

这不就是它的用途吗?

在提交消息中,让摘要行汇总该事实,然后编写您希望在那里传达的任何详细消息。

以编程方式,您可以编写一个Deprecated机制,警告不再维护此项目。还有去哪里。

答案 1 :(得分:1)

所以通常当我在我的Gemfile中引用git / github时,这是一个非常特殊的原因。 Bundling在Gemfile.lock中放置一个特定的SHA。如果一切正常,我一般都会谨慎地运行bundle update,而且我肯定会在运行bundle update some-gem-from-some-github-repo之前检查出什么是新的或已经有特殊原因想要这样做一个不同的SHA。

所以我认为在自述文件的顶部有一个很明显的通知,即您的更改已合并并且您不再维护您的分支就足够了。