Flesh out release.yml workflow

Author: jdee

.github/custom-scripts/create-release.js

@@ -0,0 +1,65 @@
+function getFirstLine(message) {
+  const index = message.indexOf('\n');
+  if (index === -1) {
+    return message;
+  }
+
+  return message.slice(0, index);
+}
+
+async function getBody({ github, core, context, target }) {
+  const res = await github.repos.getLatestRelease({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+  });
+
+  const latestRelease = res.data;
+  const diff = await github.repos.compareCommits({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    base: latestRelease.tag_name,
+    head: target,
+  });
+
+  const commits = diff.data.commits;
+  if (!commits.length) {
+    return 'No changes';
+  }
+
+  const format = (log) => `* ${log.title} (${log.hash}) ${log.name} <${log.email}>`;
+  const lines = commits.map((c) => {
+    const payload = {
+      title: getFirstLine(c.commit.message),
+      hash: c.sha.slice(0, 7),
+      name: c.commit.author.name,
+      email: c.commit.author.email,
+    };
+    return format(payload);
+  });
+
+  return lines.join('\n');
+}
+
+/**
+ * Create Github Release given the version (provided by a tag)
+ */
+async function createRelease({ context, core, github, sha, version }) {
+  const title = `### Release Note (${version})`;
+  const body = await getBody({ github, core, context, target: sha });
+  const releaseBody = `${title}\n\n${body}`;
+
+  const release = {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    tag_name: version,
+    target_commitish: sha,
+    name: version,
+    body: releaseBody,
+    draft: false,
+    prelease: false,
+  };
+
+  await github.repos.createRelease(release);
+}
+
+module.exports = createRelease;

.github/workflows/release.yml

@@ -1,23 +1,72 @@
 name: Tag & Release
 
-# -----
-# TODO: Define this workflow.
-# -----
-
 # Manually triggered
-# $ gh workflow run integration-tests.yml
+# $ gh workflow run -f version=1.40.0 release.yml
 on: workflow_dispatch
+  inputs:
+    version:
+      description: The version number to use for this release.
+      required: true
 
+# Builds two frameworks in parallel, then commits checksums, releases
+# with the frameworks and checksums attached to the release.
 jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Build xcframework
+        working-directory: carthage-files
+        run: |
+          xcodebuild -scheme Branch-xcframework
+          cd build
+          zip -rqy Branch.zip Branch.xcframework/
+          echo '#checksum for Branch.zip on Github' > checksum.txt
+          shasum Branch.zip >> checksum
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: Branch-xcframework
+          paths:
+            - carthage-build/Branch.zip
+            - carthage-build/checksum
+
+  build-static:
+    runs-on: macos-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Build static xcframework
+        working-directory: carthage-files
+        run: |
+          xcodebuild -scheme Branch-static-xcframework
+          cd build
+          zip -rqy Branch-static.zip Branch.xcframework/
+          echo '#checksum for Branch-static.zip on Github' > checksum.txt
+          shasum Branch_static.zip >> checksum_static
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: Branch-static-xcframework
+          paths:
+            - carthage-build/Branch_static.zip
+            - carthage-build/checksum_static
+
   release:
     runs-on: macos-latest
+    needs: [build, build-static]
     steps:
       - name: Check out code
         uses: actions/checkout@v2
       - name: Set up Ruby 2.7
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.7'
+      # The CocoaPods dependencies are only used by the
+      # Branch-TestBed.xcworkspace (for unit tests).
+      # Bring in the Ruby deps from the cache for quick availability of
+      # pod command. Not using cached Pods folder.
       - name: Restore cache
         uses: actions/cache@v2
         with:
@@ -31,24 +80,48 @@ jobs:
         run: |
           bundle config set --local path vendor
           bundle check || bundle install
-      # This happens automatically with the unit_tests lane, but adding it here
-      # makes it easier to keep track of installation time via GHA without
-      # adding execution time to the next step.
-      - name: Install CocoaPods dependencies
-        run: bundle exec fastlane prepare_pods
-
-      # 1. Publish to CocoaPods.
+      - name: Download build artifacts
+        uses: actions/download-artifact@v2
+      - name: Verify build artifacts
+        working-directory: carthage-files
+        run: |
+          ls -R
+      # The sha output from this step is the commit to be tagged.
+      - name: Commit checksums
+        id: commit-checksums
+        run: |
+          git config user.name "Branch SDK Team"
+          git config user.email [email protected]
+          git commit carthage-files/checksum carthage-files/checksum_static -m'Updated checksums'
+          echo "::set-output name=sha::$(git rev-parse HEAD)"
+      # TODO: Version bump along the way, probably here.
+      - name: Push changes
+        run: |
+          git push
       - name: Publish to CocoaPods
         run: |
+          # TODO: Authenticate
+          # bundle exec pod trunk push Branch.podspec
           echo "TODO: This 👆"
-      # 2. Create GitHub release. Also creates a tag.
-      # Remember to build and attach binaries.
+      # 3. Create GitHub release. Also creates a tag.
       - name: Create GitHub Release
         uses: actions/github-script@v4
         with:
           script: |
-            console.log('TODO: This 👆');
-      # 3. Trigger import workflow in ios-spm repo.
+            const createRelease = require('./.github/custom-scripts/create-release');
+            const tagName = '${{ github.event.inputs.version }}';
+            const sha = '${{ steps.commit-checksums.outputs.sha }}';
+            const release = await createRelease({
+              core,
+              context,
+              github,
+              sha,
+              tagName,
+            });
+
+            console.log(`Created release ${tagName}:`);
+            console.log(` ${JSON.stringify(release)}`);
+      # 4. Trigger import workflow in ios-spm repo.
       - name: Export to ios-spm repository
         uses: actions/github-script@v4
         with:

.github/workflows/verify.yml

@@ -4,7 +4,6 @@ on:
   pull_request:
     branches:
       - master
-      - production
 
 jobs:
   verify:

Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'cocoapods', '~> 1.9'
 gem 'fastlane', '~> 2.69'
+gem 'pattern_patch', '~> 0.5'
 
 plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
 eval_gemfile(plugins_path) if File.exist?(plugins_path)

Gemfile.lock

@@ -104,7 +104,7 @@ GEM
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     fastimage (2.2.4)
-    fastlane (2.185.0)
+    fastlane (2.185.1)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.3, < 3.0.0)
       artifactory (~> 3.0)
@@ -146,7 +146,7 @@ GEM
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    google-apis-androidpublisher_v3 (0.5.0)
+    google-apis-androidpublisher_v3 (0.6.0)
       google-apis-core (~> 0.1)
     google-apis-core (0.3.0)
       addressable (~> 2.5, >= 2.5.1)
@@ -206,6 +206,8 @@ GEM
     naturally (2.2.1)
     netrc (0.11.0)
     os (1.1.1)
+    pattern_patch (0.5.4)
+      activesupport
     plist (3.6.0)
     public_suffix (4.0.6)
     rake (13.0.3)
@@ -265,6 +267,7 @@ PLATFORMS
 DEPENDENCIES
   cocoapods (~> 1.9)
   fastlane (~> 2.69)
+  pattern_patch (~> 0.5)
 
 BUNDLED WITH
-   2.2.19
+   2.2.20

fastlane/Fastfile

@@ -1,9 +1,11 @@
-require_relative 'lib/helper/update_helper'
+require_relative 'lib/helper/cocoapods_helper'
+require_relative 'lib/helper/version_helper'
 
 fastlane_version "2.69.0"
 
 lane :prepare_pods do
   # This helps optimize CI with caching by testing whether a pod install is necessary
+  # from cocoapods_helper
   pod_install_if_required '../Branch-TestBed'
   # Can also turn on verbose output and disable repo update
   # pod_install_if_required '../Branch-TestBed', verbose: true, repo_update: false
@@ -20,3 +22,13 @@ lane :integration_tests do
   # This testplan includes unit tests as well as integration tests.
   scan scheme: 'Branch-TestBed'
 end
+
+# bundle exec fastlane version_bump version:patch # default
+# bundle exec fastlane version_bump version:minor
+# bundle exec fastlane version_bump version:major
+# bundle exec fastlane version_bump version:1.41.0
+lane :version_bump do |opts|
+  # from version_helper
+  next_version = update_sdk_version version: opts[:version]
+  sh 'git', 'commit', '-a', '-m', "[release] #{next_version}"
+end

fastlane/lib/helper/update_helper.rb renamed to fastlane/lib/helper/cocoapods_helper.rb

@@ -1,10 +1,10 @@
 require 'cocoapods'
 require 'pathname'
 
-module UpdateHelper
+module CocoapodsHelper
   UI = FastlaneCore::UI
 
-  class UpdateHelperException < RuntimeError; end
+  class CocoapodsHelperException < RuntimeError; end
 
   # Following the lead of npm ci (https://docs.npmjs.com/cli/v7/commands/npm-ci):
   # The Podfile.lock must exist.
@@ -31,7 +31,7 @@ def pod_install_required?(podfile_folder)
     manifest_path = File.join podfile_folder, 'Pods', 'Manifest.lock'
 
     # Don't regenerate the lockfile
-    raise UpdateHelperException, "#{lockfile_path} missing or not readable." unless File.readable?(lockfile_path)
+    raise CocoapodsHelperException, "#{lockfile_path} missing or not readable." unless File.readable?(lockfile_path)
 
     return true unless File.readable?(manifest_path)
 
@@ -58,7 +58,7 @@ def pod_install_required?(podfile_folder)
     end
 
     # Don't regenerate the lockfile.
-    raise UpdateHelperException, "Podfile checksum #{podfile.checksum} does not match PODFILE CHECKSUM in Podfile.lock."
+    raise CocoapodsHelperException, "Podfile checksum #{podfile.checksum} does not match PODFILE CHECKSUM in Podfile.lock."
   end
 
   def pod_install_if_required(podfile_folder, verbose: false, repo_update: true)
@@ -75,4 +75,4 @@ def pod_install_if_required(podfile_folder, verbose: false, repo_update: true)
   end
 end
 
-include UpdateHelper
+include CocoapodsHelper