Skip to content

Commit

Permalink
Release first beta (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
zippolyte authored Dec 10, 2020
1 parent d6037e6 commit 8f91a9e
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ failed.txt
rerun.txt
coverage/
examples/
datadog_api_client-*.gem
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CHANGELOG

## 1.0.0-beta.1 / 2020-12-09

* [Added] First beta release of the Ruby datadog-api-client library
46 changes: 46 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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](https://bundler.io/) and setup your RubyGems credentials:
1. Register an account on https://rubygems.org/
1. *Datadog Admins only* - Be assigned to Datadog's RubyGems gems by an owner.
1. Set a `~/.gem/credentials` file as the following:
```
---
:rubygems_api_key: $RUBYGEMS_APIKEY
```
1. Install [datadog_checks_dev](https://datadog-checks-base.readthedocs.io/en/latest/datadog_checks_dev.cli.html#installation) using Python 3.
1. Install [gem-release](https://github.com/svenfuchs/gem-release#installation).

### 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. Bump the version. e.g. `gem bump -v 1.0.0`.
1. Merge the PR to master.
1. Create the release in the [Github releases page](https://github.com/DataDog/datadog-api-client-ruby/releases).
1. Checkout the tag created at the previous step.
1. Release the gem: `gem release`.
1. Check that the [Ruby Gem is published](https://rubygems.org/gems/datadog_api_client).
1. Bump the version again to a dev version (e.g. `gem bump -v 1.0.1+dev`), open a PR and merge it to master.
2 changes: 1 addition & 1 deletion lib/datadog_api_client/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'rbconfig'

module DatadogAPIClient
VERSION = '0.1.0'
VERSION = '1.0.0-beta.1'

USER_AGENT = format(
'datadog-api-client-ruby/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s)',
Expand Down

0 comments on commit 8f91a9e

Please sign in to comment.