Document SDK release process #5235
Merged
Conversation
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
Resolves: spiffe#4284 Signed-off-by: Andrew Harding <azdagron@gmail.com>
azdagron
requested review from
evan2645,
amartinezfayo,
MarcosDY and
rturner3
as code owners
RELEASING.md
Outdated
|
|
||
| These SDKs need to be released with each SPIRE release. | ||
|
|
||
| SDKS releases take place using tagged commits from the `main` branch in each repository. When cutting a new release, the `main` branch needs to be prepared with any previously unreleased changes that are part of the new release. |
There was a problem hiding this comment.
Suggested change
| SDKS releases take place using tagged commits from the `main` branch in each repository. When cutting a new release, the `main` branch needs to be prepared with any previously unreleased changes that are part of the new release. | |
| SDKs releases take place using tagged commits from the `main` branch in each repository. When cutting a new release, the `main` branch needs to be prepared with any previously unreleased changes that are part of the new release. |
RELEASING.md
Outdated
| To create a release for an SDK, perform the following steps: | ||
|
|
||
| 1. Review the diff between `next` and `main`. | ||
| 1. Determine what commits in `next` that are missing from `main` that should be included in the release. |
There was a problem hiding this comment.
I'm wondering if we could include some details here that can help to aid this determination? E.g. What's the criteria to determine what are the commits that need to be cherry-picked. I'm trying to disambiguate the case where we picked a commit for SPIRE and then we added commits to the next branch in the SDKs that will not be included in that release. Maybe adding something like "... that should be included in the release because the matching SPIRE release depends on those commits." is enough?
There was a problem hiding this comment.
Sounds good. Took a stab at some new text.
Signed-off-by: Andrew Harding <azdagron@gmail.com>
amartinezfayo
approved these changes
Jun 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #4284