-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding RELEASING.md #176
Merged
Merged
Adding RELEASING.md #176
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not familiar with ios best practices.
In .NET we are releasing directly from the
main
branch. Release branches are needed only when we have changes which should no go to the patch release. In this case you can always create the branch from the tag.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Swift Package Manager uses named tags with version numbers on the repo to mark the "public" release of a new verison. E.g., the mere existence of the tag
0.5.0
"ships" that version of the package. The naming of a branch here is just for the PR to merge in a change to the version number.