Skip to content

Latest commit

 

History

History
46 lines (41 loc) · 2.43 KB

RELEASING.md

File metadata and controls

46 lines (41 loc) · 2.43 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.

Release Process

Prerequisite

Install bundler and setup your RubyGems credentials:

  1. Register an account on https://rubygems.org/
  2. Datadog Admins only - Be assigned to Datadog's RubyGems gems by an owner.
  3. Set a ~/.gem/credentials file as the following:
---
:rubygems_api_key: $RUBYGEMS_APIKEY
  1. Install datadog_checks_dev using Python 3.

Update Changelog

Commands

  • See changes ready for release by running ddev release show changes . at the root of this project. Add any missing labels to PRs if needed.
  • Run ddev release changelog . <NEW_VERSION> to update the CHANGELOG.md file at the root of this repository
  • Commit the changes to the repository in a release branch. Do not merge yet.

Release

  1. Update the gem version number in lib/dogapi/version.rb, push it to your changelog PR.
  2. Merge the PR to master.
  3. Create the release in the Github releases page.
  4. Checkout the tag created at the previous step.
  5. Build the gem: bundle exec gem build dogapi.gemspec.
  6. Push the gem: bundle exec gem push dogapi-x.x.x.gem.
  7. Check that the Ruby Gem is published.
  8. Bump the version again in lib/dogapi/version.rb to a dev version (e.g. 1.42.0 -> 1.42.1.dev), open a PR and merge it to master.