jenkinsci / sidebar-link-plugin

Jenkins sidebar-link plugin
https://plugins.jenkins.io/sidebar-link/
MIT License
26 stars 43 forks source link

Update CHANGELOG.md for existing versions up to 2.1.0 #39

Closed KalleOlaviNiemitalo closed 2 years ago

KalleOlaviNiemitalo commented 2 years ago

Update CHANGELOG.md so it describes all existing versions from 1.0 to 2.1.0. Add a link from README.md to CHANGELOG.md.

Preferably, the release notes should be in GitHub releases like https://github.com/jenkinsci/sidebar-link-plugin/releases/tag/sidebar-link-2.1.0 so that https://plugins.jenkins.io/sidebar-link/#releases would display them. I cannot make a pull request to those, though.

Related to https://github.com/jenkinsci/sidebar-link-plugin/issues/21, which suggests using Release Drafter. I have no experience with that.

KalleOlaviNiemitalo commented 2 years ago

Some earlier versions are missing as well.

jonesbusy commented 2 years ago

@KalleOlaviNiemitalo If you need help with CD release and release draft I can help with that (I used it few days ago with some plugin I maintain : https://github.com/jenkinsci/openshift-k8s-credentials-plugin)

But basically you can follow this guide to adapt the maven config for incrementals and template of workflow files : https://www.jenkins.io/doc/developer/publishing/releasing-cd/

Regards

KalleOlaviNiemitalo commented 2 years ago

In any case, I think I should populate CHANGELOG.md for the existing releases. If Release Drafter is later deployed, those entries can then be copied to the releases on GitHub, whether this PR is merged or not.

damianszczepanik commented 2 years ago

I'm happy to accept this but now this is in review state. Is it by purpose?

KalleOlaviNiemitalo commented 2 years ago

Yes, I'd like to first add information about some older versions that are not currently listed.

KalleOlaviNiemitalo commented 2 years ago

Also, the date formats are inconsistent.

damianszczepanik commented 2 years ago

Great job - thank you!

KalleOlaviNiemitalo commented 2 years ago

The README change has now propagated to https://plugins.jenkins.io/sidebar-link/#documentation.