typelevel/cats-effect

Smarter version numbers in the docs

Open

#523 创建于 2019年5月1日

在 GitHub 查看
 (23 评论) (1 反应) (0 负责人)Scala (2,230 star) (572 fork)batch import
:books: docsgood first issue

描述

When we release, we have to change the version number twice in the README and once in the tut. The README is currently included directly in the site. sbt-microsite has some automation for the latter, but can't help with the former.

  1. Consider making a more anemic README that drives straight to the site.
  2. Derive the version number in the site when publishing.

Failure to do so was responsible for #252.

Relevant Gitter conversation

贡献者指南

技术栈
无
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
sbt build tool knowledgefamiliarity with sbt microsite
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Examine the current build configuration (likely build.sbt) to understand how version numbers are set for the README and site. Look into sbt microsite's documentation for automating version derivation. Review issue #252 for context on the failure caused by manual version changes. Check the Gitter conversation linked for additional discussion points.