From 6d49d36f88054bb02627702cee1fca78d8d22bcc Mon Sep 17 00:00:00 2001 From: dvernon Date: Wed, 18 Oct 2023 10:36:25 -0600 Subject: [PATCH 1/3] Adding RELEASING.md --- RELEASING.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..f510c454 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,8 @@ +How to release splunk-otel-ios: + +* Make sure to bump the release version on both SplunkRum.swift and Podfile +* Create a release branch named “release-X.X.X” filling in X with the next release version. Ensure that this branch builds correctly. +* Run splunk-otel-ios-crashreporting locally, making sure that the dependency points to the release branch. If necessary, fix any breaking issues before releasing a new version of splunk-otel-ios. Follow the following steps with splunk-otel-ios-crashreporting as well. +* Create a signed tag with `git tag -s X.X.X` filling in X with the next release version. Push this tag to the repo. You can also use Github's release flow, which will automatically sign the tag as well. +* In github, go to the releases section on the right and click the Releases header. Then click “Draft a New Release.” Choose the tag you just created (or create a new one here) and fill in release notes. +* Release the cocoapod. Follow the steps under 'Release': https://guides.cocoapods.org/making/making-a-cocoapod.html From 9fe533b78fe35bdf8562273b5e3fc2ba68e5d130 Mon Sep 17 00:00:00 2001 From: dvernon Date: Wed, 18 Oct 2023 11:32:00 -0600 Subject: [PATCH 2/3] Updating wording clarifying release branch --- RELEASING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index f510c454..1f8b5e49 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -2,7 +2,7 @@ How to release splunk-otel-ios: * Make sure to bump the release version on both SplunkRum.swift and Podfile * Create a release branch named “release-X.X.X” filling in X with the next release version. Ensure that this branch builds correctly. -* Run splunk-otel-ios-crashreporting locally, making sure that the dependency points to the release branch. If necessary, fix any breaking issues before releasing a new version of splunk-otel-ios. Follow the following steps with splunk-otel-ios-crashreporting as well. +* Run splunk-otel-ios-crashreporting locally, making sure that the dependency points to the main branch to be released. If necessary, fix any breaking issues before releasing a new version of splunk-otel-ios. Follow the following steps with splunk-otel-ios-crashreporting as well. * Create a signed tag with `git tag -s X.X.X` filling in X with the next release version. Push this tag to the repo. You can also use Github's release flow, which will automatically sign the tag as well. * In github, go to the releases section on the right and click the Releases header. Then click “Draft a New Release.” Choose the tag you just created (or create a new one here) and fill in release notes. * Release the cocoapod. Follow the steps under 'Release': https://guides.cocoapods.org/making/making-a-cocoapod.html From 7a8dfa58e41971a84dae3f27dffdabb6a6681420 Mon Sep 17 00:00:00 2001 From: dvernon Date: Tue, 24 Oct 2023 10:50:34 -0600 Subject: [PATCH 3/3] Changing release branch to main branch --- RELEASING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index 1f8b5e49..93a304ce 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,7 +1,7 @@ How to release splunk-otel-ios: * Make sure to bump the release version on both SplunkRum.swift and Podfile -* Create a release branch named “release-X.X.X” filling in X with the next release version. Ensure that this branch builds correctly. +* Build the main branch locally to ensure it builds correctly and all unit tests are passing. * Run splunk-otel-ios-crashreporting locally, making sure that the dependency points to the main branch to be released. If necessary, fix any breaking issues before releasing a new version of splunk-otel-ios. Follow the following steps with splunk-otel-ios-crashreporting as well. * Create a signed tag with `git tag -s X.X.X` filling in X with the next release version. Push this tag to the repo. You can also use Github's release flow, which will automatically sign the tag as well. * In github, go to the releases section on the right and click the Releases header. Then click “Draft a New Release.” Choose the tag you just created (or create a new one here) and fill in release notes.