Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (28 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

51 lines (28 loc) · 2.04 KB
Raw

Contributing

Taking a Release

Follow this process when preparing and publishing a new release.

1. Validate the current state

Optionally run generate-all and validate-all manually, then confirm the latest validate-all run completed successfully before continuing.

If validate-all failed:

  • Review the failed jobs.
  • Determine whether failures stem from compilation issues or SDK breaking changes.
  • Record any modules affected by SDK breaking changes.

2. Prepare the release PRs

Run the prepare-release-prs workflow. Version handling is fully automated — no manual version changes are expected.

  • Provide SDK breaking-change modules as a comma-separated input; these receive a major bump.
  • Unlisted modules are bumped minor or patch based on detected spec changes.
  • New modules start at 1.0.0.

3. Review and update the draft release PR

Open the generated draft release PR. Its human-readable notes describe the detected spec changes — use them to identify which endpoints need review.

In your IDE:

  • Update the tests package with matching payloads and endpoints from the new spec changelog where applicable.

4. Merge the release PR

Merge the release/vX branch PR into master. A workflow then opens an automatic back-merge PR from release/vX to develop — review and merge that as well. Version handling remains automated throughout.

5. Run the publish dry run

Run the publish-all-sdks-dry-run workflow and confirm it completes successfully before publishing the release.

6. Create the GitHub release

Create a release from master, tagging it with the same version as the original release/vX branch. For example, release/v2.4.0 → release and tag v2.4.0.

7. Publish the SDKs

Creating the GitHub release automatically triggers the publish-all-sdks workflow, which publishes all SDKs and finalizes the release.

8. Confirm release

Confirm the Ruby SDK release is available on rubygems.org. The release is complete once the expected versions appear.