Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 7 commits into from
Feb 25, 2022
Merged

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

merged 7 commits into from
Feb 25, 2022

Conversation

KalleOlaviNiemitalo
Copy link
Contributor

@KalleOlaviNiemitalo KalleOlaviNiemitalo commented Feb 17, 2022

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 #21, which suggests using Release Drafter. I have no experience with that.

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue
    • Doesn't seem necessary because this PR affects documentation only.

@KalleOlaviNiemitalo
Copy link
Contributor Author

Some earlier versions are missing as well.

@KalleOlaviNiemitalo KalleOlaviNiemitalo marked this pull request as draft February 18, 2022 05:51
@jonesbusy
Copy link
Contributor

@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
Copy link
Contributor Author

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
Copy link
Member

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

@KalleOlaviNiemitalo
Copy link
Contributor Author

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

@KalleOlaviNiemitalo
Copy link
Contributor Author

Also, the date formats are inconsistent.

@KalleOlaviNiemitalo KalleOlaviNiemitalo changed the title Update CHANGELOG.md for versions 1.11.0 to 2.1.0 Update CHANGELOG.md for existing versions up to 2.1.0 Feb 21, 2022
@KalleOlaviNiemitalo KalleOlaviNiemitalo marked this pull request as ready for review February 21, 2022 17:02
CHANGELOG.md Outdated

## Version 2.0.2 (2022-02-12)

- Fix number hpi.forcompatibleSinceVersion
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The element in pom.xml is actually hpi.compatibleSinceVersion.

<hpi.compatibleSinceVersion>2.0.0</hpi.compatibleSinceVersion>

@damianszczepanik damianszczepanik merged commit 98f874e into jenkinsci:master Feb 25, 2022
@damianszczepanik
Copy link
Member

Great job - thank you!

@KalleOlaviNiemitalo
Copy link
Contributor Author

KalleOlaviNiemitalo commented Feb 26, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants