Skip to content

misc: add release readiness to contributing.md #1600

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 21, 2025
Merged

misc: add release readiness to contributing.md #1600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b57d68d
misc: add release readiness to contributing.md
0marperez May 19, 2025
aa38e46
check for ready-for-release label
0marperez May 21, 2025
9fcc0de
Merge branch 'main' of github.com:awslabs/aws-sdk-kotlin into contrib…
0marperez May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/release-readiness.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading