prepare 5.8.2 release (#168)

Author: LaunchDarklyCI

.gitignore

@@ -2,7 +2,7 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
+/docs/build
 /pkg/
 /spec/reports/
 /tmp/

.ldrelease/build-docs.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# doc generation is not part of Releaser's standard Ruby project template
+
+mkdir -p ./artifacts/
+
+cd ./docs
+make
+cd ..
+
+# Releaser will pick up docs generated in CI if we put an archive of them in the
+# artifacts directory and name it docs.tar.gz or docs.zip. They will be uploaded
+# to GitHub Pages and also attached as release artifacts. There's no separate
+# "publish-docs" step because the external service that also hosts them doesn't
+# require an upload, it just picks up gems automatically.
+
+cd ./docs/build/html
+tar cfz ../../../artifacts/docs.tar.gz *

.ldrelease/config.yml

@@ -8,10 +8,15 @@ publications:
   - url: https://www.rubydoc.info/gems/launchdarkly-server-sdk
     description: documentation
 
-template:
-  name: ruby
-  env:
-    LD_SKIP_DATABASE_TESTS: 1  # Don't run Redis/Consul/DynamoDB tests in release; they are run in CI
+circleci:
+  linux:
+    image: circleci/ruby:2.6.2-stretch
+    context: org-global
+    env:
+      LD_SKIP_DATABASE_TESTS: "1"  # Don't run Redis/Consul/DynamoDB tests in release; they are run in CI
+
+documentation:
+  githubPages: true
 
 sdk:
   displayName: "Ruby"

.yardopts

@@ -5,6 +5,8 @@ LaunchDarkly Server-side SDK for Ruby
 
 [![Circle CI](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master)
 [![Security](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master.svg)](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master)
+[![RubyDoc](https://img.shields.io/static/v1?label=docs+-+all+versions&message=reference&color=00add8)](https://www.rubydoc.info/gems/launchdarkly-server-sdk)
+[![GitHub Pages](https://img.shields.io/static/v1?label=docs+-+latest&message=reference&color=00add8)](https://launchdarkly.github.io/ruby-server-sdk)
 
 LaunchDarkly overview
 -------------------------
@@ -27,7 +29,7 @@ Learn more
 
 Check out our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [reference guide for this SDK](http://docs.launchdarkly.com/docs/ruby-sdk-reference).
 
-Generated API documentation is on [RubyDoc.info](https://www.rubydoc.info/gems/launchdarkly-server-sdk).
+Generated API documentation for all versions of the SDK is on [RubyDoc.info](https://www.rubydoc.info/gems/launchdarkly-server-sdk). The API documentation for the latest version is also on [GitHub Pages](https://launchdarkly.github.io/ruby-server-sdk).
 
 Testing
 -------

README.md

@@ -0,0 +1,26 @@
+
+ifeq ($(LD_RELEASE_VERSION),)
+TITLE=LaunchDarkly Ruby SDK
+else
+TITLE=LaunchDarkly Ruby SDK ($(LD_RELEASE_VERSION))
+endif
+
+.PHONY: dependencies html
+
+html: dependencies
+	rm -rf ./build
+	cd .. && yard doc \
+		-o docs/build/html \
+		--title "$(TITLE)" \
+		--no-private \
+		--markup markdown \
+		--embed-mixins \
+		-r docs/index.md \
+		lib/*.rb \
+		lib/**/*.rb \
+		lib/**/**/*.rb \
+		lib/**/**/**/*.rb
+
+dependencies:
+	gem install --conservative yard
+	gem install --conservative redcarpet  # provides Markdown formatting

docs/Makefile

@@ -0,0 +1,9 @@
+# LaunchDarkly Server-side SDK for Ruby
+
+This generated API documentation lists all types and methods in the SDK.
+
+The API documentation for the most recent SDK release is hosted on [GitHub Pages](https://launchdarkly.github.io/ruby-server-sdk). API documentation for current and past releases is hosted on [RubyDoc.info](https://www.rubydoc.info/gems/launchdarkly-server-sdk).
+
+Source code and readme: [GitHub](https://github.com/launchdarkly/ruby-server-sdk)
+
+SDK reference guide: [docs.launchdarkly.com](https://docs.launchdarkly.com/sdk/server-side/ruby)