Repository navigation
Title: docs, ci: pin guidance, API migration guide, issue template checks, and CLI release binaries - #553
Merged
Conversation
- Implemented `check-issue-templates.rb` to validate issue template metadata. - Created `package-cli.sh` for packaging the soroban-testkit CLI binary for various release targets. - Added test data for invalid issue templates to ensure validation works correctly. - Updated CI workflow to include checks for issue template metadata. - Enhanced release workflow to build and package CLI binaries for supported targets. - Added `MIGRATION.md` and updated `COMPATIBILITY.md` for API migration guidance and version pinning instructions. - Updated documentation in `README.md` and `RELEASING.md` to reflect new features and requirements.
This file contains hidden or 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
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.
closes #409 - Documents how to pin a matching soroban-sdk and testkit version in COMPATIBILITY.md, including the protocol note and troubleshooting for version conflicts.
The docs workflow now fails if the exact SDK pin is missing from that guide.
closes #408 - Adds MIGRATION.md with one section per minor release and a maintainer template for writing them.
The docs workflow requires a matching heading for any minor release, and RELEASING.md now asks for one.
closes #410 - Adds a checker for issue form and markdown template metadata, run in a new issue-templates CI job.
A deliberately broken fixture must fail the checker, so a checker that accepts everything cannot pass CI.
closes #411 - Builds the CLI for Linux x86_64, macOS x86_64 and arm64, and Windows x86_64, and attaches .tar.gz archives and .sha256 checksums to the GitHub release.
Packaging lives in a helper script that rejects unsupported targets, and RELEASING.md documents the assets.