From b57d68dcb66e17df595deb514844dd6fafe69bb4 Mon Sep 17 00:00:00 2001 From: 0marperez Date: Mon, 19 May 2025 16:05:54 -0400 Subject: [PATCH 1/2] misc: add release readiness to contributing.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b25778ae66..0d2f5b74549 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -211,6 +211,17 @@ The `.api` files can be updated by running `./gradlew apiDump`. The binary compatibility validator can also be run manually using `./gradlew apiCheck`. +#### Release readiness + +This checks for cross repo changes by looking at matching branch names across repos. +It verifies that downstream changes are ready to be released. If your change spans +multiple repos (aws-sdk-kotlin, smithy-kotlin, aws-crt-kotlin), the upstream +changes must be merged and released first. For release assistance ask the team +to run a release for you. + +If this check is failing, and you have cross repo changes that do not rely on +each other, you can add the `ready-for-release` label to your PR to override it. + ## Finding contributions to work on 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. From aa38e46603e13e5f4af20bdd5e52e7c0547a0c88 Mon Sep 17 00:00:00 2001 From: 0marperez Date: Wed, 21 May 2025 10:21:50 -0400 Subject: [PATCH 2/2] check for ready-for-release label --- .github/workflows/release-readiness.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release-readiness.yml b/.github/workflows/release-readiness.yml index 30bbafc49bc..871894e511a 100644 --- a/.github/workflows/release-readiness.yml +++ b/.github/workflows/release-readiness.yml @@ -9,6 +9,7 @@ on: jobs: release-readiness: + if: ${{ !contains(github.event.pull_request.labels.*.name, 'ready-for-release') }} runs-on: ubuntu-latest steps: - name: Checkout SDK