Skip to content

Commit 3c0bf13

Browse files
author
Edward Smith
committed
Updated release documentation.
1 parent 4ca4955 commit 3c0bf13

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

iOS_SDK_Release_Procedure

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
iOS SDK Release Procedure Last update: 9/9/2016
1+
iOS SDK Release Procedure Last update: 10/25/2016
22
======================================
33

44
Steps to release the iOS SDK:
@@ -7,25 +7,23 @@ Steps to release the iOS SDK:
77
• are they fixing a partner issue?
88
• are there tests that verify the correctness of the change?
99

10-
2) Accept the pull requests and merge them into the project.
10+
2) Accept the pull requests and merge them into the project.
1111
• get a thumbs-up from at least one person
1212
• merge them one at a time, to verify no conflicts
1313
• delete the branches you merge (they can be restored later if necessary)
1414

1515
3) Make sure that the code builds from XCode
16-
• git checkout staging
16+
• git checkout QA
1717
• git pull
1818
• run the Testbed from XCode and make sure it works
19-
• git checkout master
20-
• git merge staging
2119

2220
3) Run the pre-release script
2321
• from the root directory of the iOS SDK, run 'sh scripts/pre-release.sh'
2422
• verifies our cocoapod definition file
2523
• (more details! What to do if it fails?)
2624

2725
4) Run the release script
28-
• this script requires a new version number as an argument (ex: 0.8.5)
26+
• this script requires a new version number as an argument (ex: 0.8.5)
2927
• from the root directory of the iOS SDK, run 'sh scripts/release.sh <version>' (ex 0.8.5)
3028
• this script does several things:
3129
• it opens the changelog on the command line. Add release notes here and save them.
@@ -52,7 +50,7 @@ Steps to release the iOS SDK:
5250
• run carthage build --no-skip-current && carthage archive Branch
5351
• go to https://github.com/BranchMetrics/ios-branch-deep-linking/releases and click on Draft a new release
5452
• Choose the release version, put some funny (required!) title and add the ChangeLog to the Description
55-
• In the attachment sections, chosee the zipped framework in the carthage-files directory (different from the fabric one)
53+
• In the attachment sections, choose the zipped framework in the carthage-files directory (different from the fabric one)
5654
• Publish Release
5755

5856
Important Note about Carthage:

scripts/pre-release.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
#!/bin/bash
2-
3-
pod lib lint Branch.podspec --verbose
2+
pod lib lint Branch.podspec --verbose

scripts/release.sh

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#!/bin/bash
2+
set -euo pipefail
23

34
[ $# -eq 0 ] && { echo "Usage: $0 1.0.0"; exit 1; }
45

@@ -23,14 +24,14 @@ sed 's/Branch iOS SDK change log/Branch iOS SDK change log\
2324
- v'$1'\
2425
*/' <$CHANGELOG_LOC >$SED_TMP_LOC && mv $SED_TMP_LOC $CHANGELOG_LOC
2526

26-
# Prompt for editor input for ChangeLog.
27+
# Prompt for editor input for ChangeLog.
2728
vim +4 +star $CHANGELOG_LOC
2829

2930
# Build the framework
3031
sh $SCRIPT_DIR/build_framework.sh
3132

3233
# Commit and tag
33-
git add .
34+
git add --all
3435
git commit -m "Updates for $1 release."
3536
git tag $1
3637
git push --tags origin master
@@ -42,4 +43,4 @@ pod trunk push $PODSPEC_LOC
4243
sh $SCRIPT_DIR/upload_zips.sh
4344

4445
# Prompt for SDK Releases Group post
45-
open https://groups.google.com/forum/#!newtopic/branch-sdk-releases
46+
open 'https://groups.google.com/forum/#!newtopic/branch-sdk-releases'

0 commit comments

Comments
 (0)