prepare 2.0.0-rc.1 release

.circleci/config.yml

@@ -11,14 +11,15 @@ workflows:
 jobs:  
   test-netstandard2.0:
     docker:
-      - image: mcr.microsoft.com/dotnet/core/sdk:2.1-focal
+      - image: mcr.microsoft.com/dotnet/sdk:5.0-focal
     environment:
       ASPNETCORE_SUPPRESSSTATUSMESSAGES: "true" # suppresses annoying debug output from embedded HTTP servers in tests
     steps:
       - checkout
-      - run: dotnet restore
-      - run: dotnet build src/LaunchDarkly.XamarinSdk -f netstandard2.0
-      - run: dotnet test -v=normal tests/LaunchDarkly.XamarinSdk.Tests/LaunchDarkly.XamarinSdk.Tests.csproj -f netcoreapp2.1
+      - run: dotnet restore src/LaunchDarkly.ClientSdk
+      - run: dotnet build src/LaunchDarkly.ClientSdk -f netstandard2.0
+      - run: dotnet restore tests/LaunchDarkly.ClientSdk.Tests
+      - run: dotnet test -v=normal tests/LaunchDarkly.ClientSdk.Tests/LaunchDarkly.ClientSdk.Tests.csproj
 
   test-android:
     macos:
@@ -33,11 +34,11 @@ jobs:
 
       - run:
           name: Install .NET/Xamarin build tools
-          command: ./scripts/macos-install-xamarin.sh android
+          command: .circleci/scripts/macos-install-xamarin.sh android
 
       - run:
           name: Install Android SDK
-          command: ./scripts/macos-install-android-sdk.sh 27
+          command: .circleci/scripts/macos-install-android-sdk.sh 27
 
       - run:
           name: Set up emulator
@@ -54,13 +55,13 @@ jobs:
           name: Build SDK
           command: |
             msbuild /restore /p:TargetFramework=MonoAndroid81 \
-              src/LaunchDarkly.XamarinSdk/LaunchDarkly.XamarinSdk.csproj
+              src/LaunchDarkly.ClientSdk/LaunchDarkly.ClientSdk.csproj
 
       - run:
           name: Build test project
           command: |
             msbuild /restore /t:SignAndroidPackage \
-              tests/LaunchDarkly.XamarinSdk.Android.Tests/LaunchDarkly.XamarinSdk.Android.Tests.csproj
+              tests/LaunchDarkly.ClientSdk.Android.Tests/LaunchDarkly.ClientSdk.Android.Tests.csproj
 
       - run:
           name: Wait for emulator
@@ -75,7 +76,7 @@ jobs:
 
       - run:
           name: Deploy app to emulator
-          command: adb install tests/LaunchDarkly.XamarinSdk.Android.Tests/bin/Debug/com.launchdarkly.xamarinandroidtests-Signed.apk
+          command: adb install tests/LaunchDarkly.ClientSdk.Android.Tests/bin/Debug/com.launchdarkly.xamarinandroidtests-Signed.apk
 
       - run:
           name: Start app in emulator
@@ -103,27 +104,15 @@ jobs:
 
       - run:
           name: Install .NET/Xamarin build tools
-          command: ./scripts/macos-install-xamarin.sh ios
+          command: .circleci/scripts/macos-install-xamarin.sh ios
 
       - run:
           name: Build SDK
-          command: msbuild /restore /p:Configuration=Debug /p:TargetFramework=Xamarin.iOS10 src/LaunchDarkly.XamarinSdk/LaunchDarkly.XamarinSdk.csproj
-
-      - run:
-          name: Pre-build storyboard
-          command: >-
-            /Applications/Xcode.app/Contents/Developer/usr/bin/ibtool --errors --warnings --notices --output-format xml1 --minimum-deployment-target 10.0
-            --target-device iphone --target-device ipad --auto-activate-custom-fonts
-            --sdk /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.4.sdk
-            --compilation-directory /Users/distiller/project/tests/LaunchDarkly.XamarinSdk.iOS.Tests/obj/iPhoneSimulator/Debug/xamarin.ios10/ibtool
-            /Users/distiller/project/tests/LaunchDarkly.XamarinSdk.iOS.Tests/LaunchScreen.storyboard
-          # This is the exact ibtool command that msbuild runs to build the first storyboard. The difference is that msbuild sets some environment variables
-          # which cause this command to fail. By pre-running this command, some unknown state gets set up that allows future calls to ibtool to succeed.
-          # It is unclear where this state resides or how this works...
+          command: msbuild /restore /p:Configuration=Debug /p:TargetFramework=Xamarin.iOS10 src/LaunchDarkly.ClientSdk/LaunchDarkly.ClientSdk.csproj
 
       - run:
           name: Build test project
-          command: msbuild /restore /p:Configuration=Debug /p:Platform=iPhoneSimulator tests/LaunchDarkly.XamarinSdk.iOS.Tests/LaunchDarkly.XamarinSdk.iOS.Tests.csproj
+          command: msbuild /restore /p:Configuration=Debug /p:Platform=iPhoneSimulator tests/LaunchDarkly.ClientSdk.iOS.Tests/LaunchDarkly.ClientSdk.iOS.Tests.csproj
           # Note that we must specify Platform=iPhoneSimulator here explicitly because, when using a current
           # version of msbuild with a project file that uses MSBuild.Sdk.Extras, it seems like Platform does *not*
           # default to an empty string (I think it defaults to "AnyCPU"), therefore it will try to build it for a
@@ -138,16 +127,16 @@ jobs:
 
       - run:
           name: Load test app into simulator
-          command: xcrun simctl install "xm-ios" tests/LaunchDarkly.XamarinSdk.iOS.Tests/bin/Debug/xamarin.ios10/LaunchDarkly.XamarinSdk.iOS.Tests.app
+          command: xcrun simctl install "xm-ios" tests/LaunchDarkly.ClientSdk.iOS.Tests/bin/Debug/xamarin.ios10/LaunchDarkly.ClientSdk.iOS.Tests.app
 
       - run:
           name: Start capturing log output
-          command: xcrun simctl spawn booted log stream --predicate 'senderImagePath contains "LaunchDarkly.XamarinSdk.iOS.Tests"' | tee test-run.log
+          command: xcrun simctl spawn booted log stream --predicate 'senderImagePath contains "LaunchDarkly.ClientSdk.iOS.Tests"' | tee test-run.log
           background: true
 
       - run:
           name: Launch test app in simulator
-          command: xcrun simctl launch "xm-ios" com.launchdarkly.XamarinSdkTests
+          command: xcrun simctl launch "xm-ios" com.launchdarkly.ClientSdkTests
 
       - run:
           name: Wait for tests to finish running

scripts/macos-install-xamarin.sh → .circleci/scripts/macos-install-xamarin.sh

@@ -22,7 +22,8 @@
 set -e
 
 # The .NET SDK 5.0 installer is pinned to a specific version
-DOTNET_SDK_INSTALLER_URL=https://download.visualstudio.microsoft.com/download/pr/de613120-9306-4867-b504-45fcc81ba1b6/2a03f18c549f52cf78f88afa44e6dc6a/dotnet-sdk-5.0.201-osx-x64.pkg
+# See: https://dotnet.microsoft.com/download/dotnet/5.0
+DOTNET_SDK_INSTALLER_URL=https://download.visualstudio.microsoft.com/download/pr/88bc1553-e90f-4a4f-9574-65d9a5065cd2/1d5646e1abb8b4d4a61ba0b0be976047/dotnet-sdk-5.0.402-osx-x64.pkg
 
 # Currently we are also pinning the rest of the installers to specific version URLs.
 # Alternately, we could use the "latest stable" mode of boots:
@@ -72,3 +73,15 @@ do
       exit 1
   esac
 done
+
+# In the CircleCI environment, /Applications/Xcode.app might be a symlink. The build
+# tools can be confused by this (https://github.com/xamarin/xamarin-macios/issues/11006)
+# so we'll just move things around so that is a real file.
+
+if [[ -L /Applications/Xcode.app ]]; then
+  cd /Applications
+  real_xcode=`readlink Xcode.app`
+  rm Xcode.app
+  mv "$real_xcode" Xcode.app
+  sudo xcode-select --switch /Applications/Xcode.app
+fi

.ldrelease/build-docs.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -eu
+
+# This script is only run in the Dockerized Linux job that is used for building
+# documentation.
+
+# This is a hack to deal with the conflict between two requirements:
+# 1. Currently Xamarin projects must be built with msbuild, so the project file
+#    must use "MSBuild.Sdk.Extras".
+# 2. Our documentation build process uses the dotnet CLI command, so it expects
+#    the project file to use "Microsoft.NET.Sdk" instead.
+# As long as we are not building any Xamarin-specific targets, but only the .NET
+# Standard target, it is OK to use "Microsoft.NET.Sdk". This script modifies the
+# project file (only within the Docker container, not in source control) so it
+# will build with "Microsoft.NET.Sdk" during this job.
+
+PROJECT_FILE=./src/LaunchDarkly.ClientSdk/LaunchDarkly.ClientSdk.csproj
+
+cp "${PROJECT_FILE}" "${PROJECT_FILE}.bak"
+sed "s/MSBuild.Sdk.Extras/Microsoft.NET.Sdk/g" "${PROJECT_FILE}" > "${PROJECT_FILE}.tmp"
+mv "${PROJECT_FILE}.tmp" "${PROJECT_FILE}"
+
+# Now run the actual build-docs script from Releaser's project template
+${LD_RELEASE_TEMP_DIR}/../template/build-docs.sh
+
+# Change the project file back
+mv "${PROJECT_FILE}.bak" "${PROJECT_FILE}"

.ldrelease/config.yml

@@ -1,34 +1,45 @@
-repo:
-  public: xamarin-client-sdk
-  private: xamarin-client-sdk-private
+version: 2
 
-circleci:
-  mac:
-    xcode: "12.4.0"
-  windows:  # only for building documentation
-    env:
-      LD_RELEASE_DOCS_TARGET_FRAMEWORK: netstandard2.0
-      LD_RELEASE_DOCS_ASSEMBLIES: LaunchDarkly.XamarinSdk LaunchDarkly.CommonSdk
-    steps:
-      - step: build
-      - step: build-docs
-      - step: publish-docs
+repo:
+  public: dotnet-client-sdk
+  private: dotnet-client-sdk-private
 
-releasableBranches:
+branches:
   - name: master
     description: 2.x
   - name: 1.x
 
-template:
-  name: dotnet-windows  # only for building documentation
+jobs:
+  # The main build happens on a Mac host
+  - circleCI:
+      mac:
+        xcode: "12.4.0"
+      context: org-global
+      steps:
+        - step: prepare
+        - step: build
+        - step: test
+        - step: publish
+
+  # Documentation is built in a Linux container
+  - template:
+      name: dotnet-linux
+      skip:
+        - test
+        - publish
+        - publish-dry-run
+    env:
+      BUILDFRAMEWORKS: netstandard2.0
+      LD_RELEASE_DOCS_TARGET_FRAMEWORK: netstandard2.0
+      LD_RELEASE_DOCS_ASSEMBLIES: LaunchDarkly.ClientSdk LaunchDarkly.CommonSdk
 
 publications:
-  - url: https://www.nuget.org/packages/LaunchDarkly.XamarinSdk
+  - url: https://www.nuget.org/packages/LaunchDarkly.ClientSdk
     description: NuGet
 
 documentation:
-  title: LaunchDarkly Client-Side SDK for Xamarin
-  githubPages: true
+  title: LaunchDarkly Client-Side SDK for .NET
+  gitHubPages: true
 
 sdk:
-  displayName: "Xamarin"
+  displayName: ".NET (client-side)"

.ldrelease/mac-build.sh

@@ -2,7 +2,36 @@
 
 set -eu
 
-# Build the project for all target frameworks. This includes building the .nupkg, because of
-# the <GeneratePackageOnBuild> directive in our project file.
+PROJECT_FILE=src/LaunchDarkly.ClientSdk/LaunchDarkly.ClientSdk.csproj
 
-msbuild /restore /p:Configuration=Debug src/LaunchDarkly.XamarinSdk/LaunchDarkly.XamarinSdk.csproj
+# Build the project for all target frameworks. This does not include building the
+# .nupkg, because we didn't set <GeneratePackageOnBuild> in our project file; we
+# don't want to create the package until we've signed the assemblies.
+
+msbuild /restore /p:Configuration=Release "${PROJECT_FILE}"
+
+# Sign the code with osslsigncode (which was installed in mac-prepare.sh)
+
+SIGNCODE_DIR="${LD_RELEASE_TEMP_DIR}/osslsigncode"
+SIGNCODE="${SIGNCODE_DIR}/osslsigncode"
+
+echo ""
+echo "Signing assemblies..."
+for dll in $(find ./src/LaunchDarkly.ClientSdk/bin/Release -name LaunchDarkly.ClientSdk.dll); do
+  echo -n "${dll}: "
+  ${SIGNCODE} sign \
+    -certs "${LD_RELEASE_SECRETS_DIR}/dotnet_code_signing_certificate" \
+    -key "${LD_RELEASE_SECRETS_DIR}/dotnet_code_signing_private_key" \
+    -readpass "${LD_RELEASE_SECRETS_DIR}/dotnet_code_signing_private_key_passphrase" \
+    -h sha1 \
+    -n "LaunchDarkly" \
+    -i "https://www.launchdarkly.com/" \
+    -t "http://timestamp.comodoca.com/authenticode" \
+    -in "${dll}" \
+    -out "${dll}.signed" || (echo "Signing failed; see log for error" >&2; exit 1)
+  mv ${dll}.signed ${dll}
+done
+
+echo ""
+echo "Creating NuGet package"
+msbuild /t:pack /p:NoBuild=true /p:Configuration=Release "${PROJECT_FILE}"

.ldrelease/mac-prepare.sh

@@ -3,8 +3,36 @@
 set -eu
 set +o pipefail
 
-./scripts/macos-install-xamarin.sh android ios
-./scripts/macos-install-android-sdk.sh 25 26 27
+./.circleci/scripts/macos-install-xamarin.sh android ios
+./.circleci/scripts/macos-install-android-sdk.sh 25 26 27
 
-export HOMEBREW_NO_AUTO_UPDATE=1
-brew install awscli
+# Download and build the osslsigncode tool. In our other .NET projects, code signing
+# is handled by our standard project template scripts for .NET, which use a Docker
+# image that already has osslsigncode installed. But here we're using a CircleCI job
+# to do the build, so we need to do the code-signing in the same place and download
+# the tool as needed. Unfortunately it has to be built from source.
+
+SIGNCODE_DOWNLOAD_URL=https://github.com/mtrojnar/osslsigncode/releases/download/2.1/osslsigncode-2.1.0.tar.gz
+SIGNCODE_ARCHIVE="${LD_RELEASE_TEMP_DIR}/osslsigncode-2.1.0.tar.gz"
+SIGNCODE_DIR="${LD_RELEASE_TEMP_DIR}/osslsigncode"
+SIGNCODE="${SIGNCODE_DIR}/osslsigncode"
+
+echo ""
+echo "Downloading osslsigncode..."
+curl --fail --silent -L "${SIGNCODE_DOWNLOAD_URL}" >"${SIGNCODE_ARCHIVE}"
+mkdir -p "${SIGNCODE_DIR}"
+tar xfz "${SIGNCODE_ARCHIVE}" -C "${SIGNCODE_DIR}"
+
+echo ""
+echo "Building osslsigncode..."
+HOMEBREW_NO_AUTO_UPDATE=1 brew install pkg-config
+export PKG_CONFIG=$(which pkg-config)
+export PKG_CONFIG_PATH=/usr/local/Cellar/openssl@1.1/1.1.1i/lib/pkgconfig
+pushd "${SIGNCODE_DIR}/osslsigncode-2.1.0"
+./configure
+make
+cp osslsigncode ..
+popd
+
+# Copy the strong-naming key that was downloaded due to our secrets.properties declaration
+cp "${LD_RELEASE_SECRETS_DIR}/LaunchDarkly.ClientSdk.snk" .

.ldrelease/mac-publish-dry-run.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -eu
+
+for pkg in $(find ./src/LaunchDarkly.ClientSdk/bin/Release -name '*.nupkg' -o -name '*.snupkg'); do
+  cp "$pkg" "${LD_RELEASE_ARTIFACTS_DIR}"
+done

.ldrelease/mac-publish.sh

@@ -2,10 +2,10 @@
 
 set -eu
 
-# Since we are currently publishing in Debug configuration, we can push the .nupkg that build.sh already built.
+NUGET_KEY=$(cat "${LD_RELEASE_SECRETS_DIR}/dotnet_nuget_api_key")
 
-export AWS_DEFAULT_REGION=us-east-1
-NUGET_KEY=$(aws ssm get-parameter --name /production/common/services/nuget/api_key --with-decryption --query "Parameter.Value" --output text)
-
-nuget push "./src/LaunchDarkly.XamarinSdk/bin/Debug/LaunchDarkly.XamarinSdk.${LD_RELEASE_VERSION}.nupkg" \
-  -ApiKey "${NUGET_KEY}" -Source https://www.nuget.org
+for pkg in $(find ./src/LaunchDarkly.ClientSdk/bin/Release -name '*.nupkg' -o -name '*.snupkg'); do
+  echo "publishing $pkg"
+  nuget push "$pkg" -ApiKey "${NUGET_KEY}" -Source https://www.nuget.org
+  echo "published $pkg"
+done

.ldrelease/mac-test.sh

@@ -4,4 +4,4 @@ set -eu
 
 # Run the .NET Standard 2.0 unit tests. (Android and iOS tests are run by regular CI jobs)
 
-dotnet test tests/LaunchDarkly.XamarinSdk.Tests/LaunchDarkly.XamarinSdk.Tests.csproj -f netcoreapp2.0
+dotnet test tests/LaunchDarkly.ClientSdk.Tests/LaunchDarkly.ClientSdk.Tests.csproj -f net5.0

.ldrelease/secrets.properties

@@ -0,0 +1,15 @@
+
+# Authenticode certificate. This is a "blob:" rather than a "param:" because it's several K of binary data.
+dotnet_code_signing_certificate=blob:/code-signing/catamorphic_code_signing_certificate.pem
+
+# Private key for the certificate.
+dotnet_code_signing_private_key=blob:/code-signing/catamorphic_code_signing_private_key.pem
+
+# Passphrase for the private key.
+dotnet_code_signing_private_key_passphrase=param:/production/common/releasing/code_signing/private_key_passphrase
+
+# NuGet API key for publishing packages.
+dotnet_nuget_api_key=param:/production/common/services/nuget/api_key
+
+# Strong-naming key.
+LaunchDarkly.ClientSdk.snk=blob:/dotnet/LaunchDarkly.ClientSdk.snk

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change log
 
-All notable changes to the LaunchDarkly Client-Side SDK for Xamarin will be documented in this file.
+All notable changes to the LaunchDarkly Client-Side SDK for .NET will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org).
 
 ## [1.2.2] - 2021-04-06