Source GitHub Release description from CHANGELOG.md

オープン
#268 コメント 3 件 リアクション 0 件 担当者 1 名 GitHub で見る

@galargh がすでに取り組んでいます。

2023年5月15日 から。

評価

この issue はまだ評価されていません。

説明

dif/medium P3

Currently we use Unified CI for tagging releases based on version.json, but we'd like to minimize the effort for cutting releases so that we can cut them more frequently.

So I propose we instead cut releases using https://github.com/pl-strflt/changelog-driven-release. Basically the workflow would look like:

  • Accumulate changes in the [Unreleased] section of the CHANGELOG
    • These should be added as commits are added, and the CHANGELOG update should happen as part of the PR for a feature
  • When ready to release, change [Unreleased] to [vX.Y.Z] YYYY-mm-dd, which is then detected by CI as a release and results in a new tag and a GitHub release with the changelog contents in the release notes.

Other requirements:

  • We currently run Kubo tests for each release, until enough are moved into Boxo, so we need to run releases on a release-vX.Y.Z branch and merge into release which should trigger the release. This way we don't have to "freeze" main while we do a release. Once the release is complete, merge release into main (which should NOT trigger a release). This is different than most folks, who just merge to main which triggers a release based on the tip of main...we do NOT want this behavior.
  • We love all the checks that Unified CI does for releases and would like to keep them (release checker workflow, which runs gorelease et al to verify the release version, call out breaking changes, etc.)
主要言語
Go
スター
326
フォーク
165
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ipfs/boxo のほかの issue

ipfs/boxo の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。