CycloneDX / CycloneDX/cyclonedx-core-java

Improve Release Process

Ouverte
#203 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Java
Étoiles
120
Forks
90
Merge moyen
12 h 43 min
PR mergées (30 j)
18

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner la page Releases du dépôt, CHANGELOG.md et la release cyclonedx-core-java-7.1.4 liée dans l’issue. Déterminez le workflow souhaité pour les release notes, le changelog et le semantic versioning ; le travail terminé doit permettre aux reviewers Dependabot en aval de comprendre clairement les changements et l’impact sur la version de chaque release.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github, java
Domaine
documentation, release
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.