Skip to content

Commit 548df05

Browse files
authored
misc: add release readiness to contributing.md (#1600)
1 parent 45d95c8 commit 548df05

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.github/workflows/release-readiness.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99

1010
jobs:
1111
release-readiness:
12+
if: ${{ !contains(github.event.pull_request.labels.*.name, 'ready-for-release') }}
1213
runs-on: ubuntu-latest
1314
steps:
1415
- name: Checkout SDK

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,17 @@ The `.api` files can be updated by running `./gradlew apiDump`.
211211

212212
The binary compatibility validator can also be run manually using `./gradlew apiCheck`.
213213

214+
#### Release readiness
215+
216+
This checks for cross repo changes by looking at matching branch names across repos.
217+
It verifies that downstream changes are ready to be released. If your change spans
218+
multiple repos (aws-sdk-kotlin, smithy-kotlin, aws-crt-kotlin), the upstream
219+
changes must be merged and released first. For release assistance ask the team
220+
to run a release for you.
221+
222+
If this check is failing, and you have cross repo changes that do not rely on
223+
each other, you can add the `ready-for-release` label to your PR to override it.
224+
214225
## Finding contributions to work on
215226
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-samples/aws-sdk-kotlin/labels/help%20wanted) issues is a great place to start.
216227

0 commit comments

Comments
 (0)