Skip to content
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 3 commits into from
Oct 24, 2023
Merged

Adding RELEASING.md #176

merged 3 commits into from
Oct 24, 2023

Conversation

dvernon-splunk
Copy link
Contributor

Adds a RELEASING.md for gdi compliance.

@dvernon-splunk dvernon-splunk requested review from a team as code owners October 18, 2023 16:37
Copy link
Contributor

@Kielek Kielek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just consider simplifying release proces.

RELEASING.md Outdated
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.
Copy link
Contributor

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.

Copy link
Contributor

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.

RELEASING.md Outdated
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.
Copy link
Contributor

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.

@dvernon-splunk dvernon-splunk merged commit 2bd2b63 into main Oct 24, 2023
3 checks passed
@dvernon-splunk dvernon-splunk deleted the dvernon/release_md branch October 24, 2023 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants