CycloneDX / CycloneDX/cyclonedx-core-java

Improve Release Process

オープン
#203 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Java
スター
120
フォーク
90
平均マージ
12時間 43分
マージ済み PR(30日)
18

説明

I would like to see an improved release process...

* [Releases](https://github.com/CycloneDX/cyclonedx-core-java/releases) populated with release notes. This will help repo watchers who configure customise events for "Releases" only.

* [CHANGELOG.md](https://github.com/CycloneDX/cyclonedx-core-java/blob/master/CHANGELOG.md) updated for every release (or replaced by the usage of release notes?)

* Improved uses of semantic versioning. Should not the additions to license mapping in 7.1.4 have warranted a minor release (7.2.0) instead of a patch release?

All of the above are used by dependabot PRs that update cyclonedx-core-java in downstream projects. Thus, addressing release notes (and/or changelog) should make a dependabot PR easier to review and approve. A difference in patch vs minor version can change the way that dependabot itself works.

As an additional justification, a wee story....

The release of [cyclonedx-core-java-7.1.4](https://github.com/CycloneDX/cyclonedx-core-java/releases/tag/cyclonedx-core-java-7.1.4) caused problems for me when it was included in `cyclonedx-maven-plugin` 2.7.0 and then BOMs generated using that release of the plugin resulted in displayed "License" in Dependency-Track to change for some components

Affected components were ones that use dual licensing and where one of the licenses now started to succesfully map to an SPDX license ID. Dependency-Track 4.5.0 does not support dual licences in the UI and prefers the ID over name. Hence the change of what license gets displayed. This caused me to spend a couple of hours investigating why things had changed. Bear in mind that the changes might have resulted in a policy violation.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、リポジトリの Releases ページ、CHANGELOG.md、および issue にリンクされている cyclonedx-core-java-7.1.4 release を確認します。release note、changelog、semantic versioning に関して求められているワークフローを判断してください。完了時には、後続の Dependabot reviewer にとって各 release の変更内容とバージョンへの影響が明確になっている必要があります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github, java
領域
documentation, release
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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