Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 3.24 KB

RELEASING.md

File metadata and controls

60 lines (43 loc) · 3.24 KB
Raw

Releasing

This document summarizes the process of doing a new release of this project. Release can only be performed by Datadog maintainers of this repository.

Schedule

This project does not have a strict release schedule. However, we would make a release at least every 2 months.

  • No release will be done if no changes got merged to the master branch during the above mentioned window.
  • Releases may be done more frequently than the above mentioned window.

Prerelease checklist

  • Check and upgrade dependencies where it applies and makes sense.
    • Create a distinct pull request and test your changes since it may introduce regressions.
    • While using the latest versions of dependencies is advised, it may not always be possible due to potential compatibility issues.
    • Upgraded dependencies should be thoroughly considered and tested to ensure they are safe!
  • Make sure tests are passing.
    • Locally and in the continuous integration system.
  • Manually test changes included in the new release.
  • Make sure documentation is up-to-date.
  • Update changelog
    • Create a distinct pull request.

Update Changelog

Prerequisite

Commands

  • See changes ready for release by running ddev -x release show changes --tag-pattern "datadog-\d+\.\d+\.\d+" --tag-prefix "datadog-" --organization jenkinsci . at the root of this project. Add any missing labels to PRs if needed.
  • Run ddev -x release changelog --tag-prefix "datadog-" --organization jenkinsci . <VERSION> to update the CHANGELOG.md file at the root of this repository.
  • Commit the changes to the repository in a release branch and get it approved/merged.

Release Process

Our team will trigger the release pipeline which will update the GitHub Jenkins CI Datadog Plugin Repository. It will create new a GitHub tag and release and push artifacts to the Jenkins CI Org Repo See the Jenkins Publishing Documentation for more details about the process.

Once released, the new version should be available in the Update Center. Releases are merged to the Jenkins-CI git repository for the Datadog-plugin, and represents the source used for plugin releases found in the Update Center in your Jenkins installation.

How to release

To release a new version:

  1. Add an entry for the new release number to the CHANGELOG.md file, and ensure that all changes are listed accurately.
  2. Clone the repository and checkout the master branch with all above changes merged in.
  3. We will trigger our release pipeline. If completed successfully, the newly updated plugin should be available from the Jenkins Update Center within ~4 hours (plus mirror propagation time).