Define CLI contracts, enhance npm workflow, and update documentation - #15
Merged
Conversation
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.
Summary
This pull request introduces comprehensive improvements to the release process for CorexPM, including a new automated release script, updated release documentation, and enhancements to the build workflow to support cross-compilation for Linux ARM64. It also formalizes the release checklist and updates the changelog for the 1.0.0 release.
Release Process Automation & Documentation:
scripts/release.sh) that validates the codebase, builds binaries, packages the npm distribution, generates SHA-256 checksums, and creates annotated git tags.docs/contributing/release-checklist.md) outlining pre-release, release, and post-release steps.docs/contributing/releases.md) to document the standard release workflow, supported targets, and step-by-step instructions.Build & CI Improvements:
.github/workflows/npm-release.yml) to support cross-compiling for Linux ARM64 by installing the appropriate toolchain and configuring the linker.Release Notes & Changelog:
CHANGELOG.md) for the 1.0.0 release, detailing all major features, release tooling, and distribution improvements.Validation
cargo fmt --all --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspaceCompatibility and security