SWIFT-134 Write a release script (#277)

Author: kmahar

.jazzy.yaml

@@ -0,0 +1,5 @@
+module: MongoSwift
+root_url: https://mongodb.github.io/mongo-swift-driver
+github_url: https://github.com/mongodb/mongo-swift-driver
+documentation: Guides/*.md
+author: Matt Broadstone, Kaitlin Mahar, and Patrick Freed

.sourcery.yml

@@ -15,7 +15,7 @@ jobs:
       os: osx
       install: ./Tests/Scripts/install_dependencies.sh sourcery
       before_script: skip
-      script: ${PWD}/sourcery/bin/sourcery; git diff --exit-code Tests/LinuxMain.swift
+      script: export sourcery=${PWD}/sourcery/bin/sourcery; make linuxmain; git diff --exit-code Tests/LinuxMain.swift
 
     - stage: tests
       os: osx

.travis.yml

@@ -5,6 +5,12 @@ else
 	FILTERARG =
 endif
 
+ifdef DOCSVERSION
+	DOCSARG = --module-version $(DOCSVERSION)
+else
+	DOCSARG =
+endif
+
 define check_for_gem
 	gem list $(1) -i > /dev/null || gem install $(1) || { echo "ERROR: Failed to locate or install the ruby gem $(1); please install yourself with 'gem install $(1)' (you may need to use sudo)"; exit 1; }
 endef
@@ -19,9 +25,9 @@ project:
 	@$(call check_for_gem,xcodeproj)
 	ruby Tests/Scripts/add_json_files.rb
 
-sourcery:
-	sourcery
-	
+linuxmain:
+	sourcery --sources Tests/ --templates Tests/LinuxMain.stencil --output Tests/LinuxMain.swift
+
 test:
 	swift test -v $(FILTERARG)
 
@@ -46,4 +52,4 @@ clean:
 documentation:
 	make project
 	@$(call check_for_gem,jazzy)
-	jazzy --module MongoSwift --module-version 0.1.0 --root-url https://mongodb.github.io/mongo-swift-driver/ --documentation=Guides/*.md
+	jazzy $(DOCSARG)

Makefile

@@ -1,12 +1,11 @@
 import mongoc
 
 private final class MongocInitializer {
-    private static let versionString = "0.1.0"
     internal static let shared = MongocInitializer()
 
     private init() {
         mongoc_init()
-        mongoc_handshake_data_append("MongoSwift", MongocInitializer.versionString, nil)
+        mongoc_handshake_data_append("MongoSwift", MongoSwiftVersionString, nil)
     }
 }
 

MongoSwift.podspec

@@ -0,0 +1,2 @@
+// swiftlint:disable:previous vertical_whitespace
+internal let MongoSwiftVersionString = "{{ argument.versionString }}"

Sources/MongoSwift/MongoSwift.swift

@@ -0,0 +1,6 @@
+// Generated using Sourcery 0.15.0 — https://github.com/krzysztofzablocki/Sourcery
+// DO NOT EDIT
+
+
+// swiftlint:disable:previous vertical_whitespace
+internal let MongoSwiftVersionString = "0.1.0"

Sources/MongoSwift/MongoSwiftVersion.stencil

@@ -0,0 +1,12 @@
+MongoSwift release process
+============================
+
+1. Ensure all the JIRA tickets for this release are resolved. You can find the releases on [this page](https://jira.mongodb.org/projects/SWIFT?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=unreleased).
+1. From the base directory of the project, run `release/release.sh` with the new version, e.g. `./release/release.sh 1.0.0`.
+1. The release script should have taken you to the GitHub page for the tag. 
+    - Click "Edit Tag".
+    - Add a title, "MongoSwift [version here]".
+    - Add a description. See [previous release notes](https://github.com/mongodb/mongo-swift-driver/releases/tag/v0.1.0) for an example of what this looks like. You can use the JIRA "Release Notes" HTML as a starting point.
+    - Click "Publish release".
+1. Mark the release as published on JIRA.
+1. Send a message to the #swift Slack channel.

Sources/MongoSwift/MongoSwiftVersion.swift

@@ -0,0 +1,59 @@
+# usage: ./release/release.sh [new version string]
+# for example: ./release/release.sh 1.0.0
+
+# update version string for libmongoc handshake
+sourcery --sources Sources/MongoSwift --templates Sources/MongoSwift/MongoSwiftVersion.stencil --output Sources/MongoSwift/MongoSwiftVersion.swift --args versionString=${1}
+
+# regenerate documentation with new version string
+export DOCSVERSION=${1}
+make documentation
+
+# commit changes
+git add docs/
+git add Sources/MongoSwift/MongoSwiftVersion.swift
+git commit -m "${1}"
+
+# tag release 
+git tag "v${1}"
+
+# push changes
+git push --tags
+
+# update podspec
+cat > ${PWD}/MongoSwift.podspec <<- EOF
+Pod::Spec.new do |spec|
+  spec.name       = "MongoSwift"
+  spec.version    = "${1}"
+  spec.summary    = "The Swift driver for MongoDB"
+  spec.homepage   = "https://github.com/mongodb/mongo-swift-driver"
+  spec.license    = 'Apache License, Version 2.0'
+  spec.authors    = {
+    "Matt Broadstone" => "[email protected]",
+    "Kaitlin Mahar" => "[email protected]",
+    "Patrick Freed" => "[email protected]"
+  }
+
+  spec.source     = {
+    :git => "https://github.com/mongodb/mongo-swift-driver.git",
+    :tag => 'v${1}'
+  }
+
+  spec.ios.deployment_target = "11.0"
+  spec.tvos.deployment_target = "10.2"
+  spec.watchos.deployment_target = "4.3"
+
+  spec.requires_arc = true
+  spec.source_files = "Sources/MongoSwift/**/*.swift"
+
+  spec.dependency 'mongo-embedded-c-driver', '~> 1.13.0-4.0.0'
+end
+EOF
+
+# publish new podspec
+pod trunk push ${PWD}/MongoSwift.podspec
+
+# cleanup podspec
+rm ${PWD}/MongoSwift.podspec
+
+# go to GitHub to publish release notes
+open "https://github.com/mongodb/mongo-swift-driver/releases/tag/v${1}"