prepare gemspec for release; specify ddtrace as dev dependency, not r…

…untime one

README.md

@@ -35,7 +35,6 @@ Datadog.configure do |c|
   # Enables the RSpec instrumentation
   c.ci.instrument :rspec, **options
 end
-
 ```
 
 `options` are the following keyword arguments:

datadog-ci.gemspec

@@ -4,35 +4,41 @@ require_relative "lib/datadog/ci/version"
 
 Gem::Specification.new do |spec|
   spec.name = "datadog-ci"
-  spec.version = Datadog::CI::VERSION
+  spec.version = Datadog::CI::VERSION::STRING
+  spec.required_ruby_version = [
+    ">= #{Datadog::CI::VERSION::MINIMUM_RUBY_VERSION}",
+    "< #{Datadog::CI::VERSION::MAXIMUM_RUBY_VERSION}"
+  ]
+  spec.required_rubygems_version = ">= 2.0.0"
   spec.authors = ["Datadog, Inc."]
   spec.email = ["dev@datadoghq.com"]
 
   spec.summary = "Datadog CI visibility for your ruby application"
-  # spec.description = "TODO: Write a longer description or delete this line."
-  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.description = <<-DESC
+  datadog-ci is a Datadog's CI visibility library for Ruby. It traces
+  tests as they are being executed and brings developers visibility into
+  their CI pipelines.
+  DESC
+
+  spec.homepage = "https://github.com/DataDog/datadog-ci-rb"
   spec.license = "BSD-3-Clause"
-  # spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
-  spec.add_dependency "ddtrace", "~> 1"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"] = "https://github.com/DataDog/datadog-ci-rb/blob/main/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DataDog/datadog-ci-rb"
+
+  spec.files =
+    Dir[*%w[
+      CHANGELOG.md
+      LICENSE*
+      NOTICE
+      README.md
+      lib/**/*
+      sig/**/*
+    ]].select { |fn| File.file?(fn) } # We don't want directories, only files
+
+  spec.require_paths = ["lib"]
 
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "ddtrace", "~> 1"
 end

lib/datadog/ci/version.rb

@@ -2,6 +2,24 @@
 
 module Datadog
   module CI
-    VERSION = "0.1.0"
+    module VERSION
+      MAJOR = "0"
+      MINOR = "1"
+      PATCH = "0"
+
+      STRING = [MAJOR, MINOR, PATCH].compact.join(".")
+
+      MINIMUM_RUBY_VERSION = "2.1.0"
+
+      # Restrict the installation of this gem with untested future versions of Ruby.
+      #
+      # This prevents crashes in the native extension code and sends a clear signal to the
+      # user that this version of the gem is untested for the host Ruby version.
+      #
+      # To allow testing with the next unreleased version of Ruby, the version check is performed
+      # as `< #{MAXIMUM_RUBY_VERSION}`, meaning prereleases of MAXIMUM_RUBY_VERSION are allowed
+      # but not stable MAXIMUM_RUBY_VERSION releases.
+      MAXIMUM_RUBY_VERSION = "3.4"
+    end
   end
 end

sig/datadog/ci/version.rbs

@@ -1,5 +1,14 @@
 module Datadog
   module CI
-    VERSION: "0.1.0"
+    module VERSION
+      MAJOR: "0"
+      MINOR: "1"
+      PATCH: "0"
+
+      STRING: String
+
+      MINIMUM_RUBY_VERSION: "2.1.0"
+      MAXIMUM_RUBY_VERSION: "3.4"
+    end
   end
 end

spec/datadog/ci/version_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Datadog::CI::VERSION do
+  it "has a version number" do
+    expect(Datadog::CI::VERSION::STRING).to eq("0.1.0")
+  end
+end