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.