Skip to content

Define CLI contracts, enhance npm workflow, and update documentation - #15

Merged
lahiruudayakumara merged 20 commits into
mainfrom
feat/phase-9-stable-release
Aug 29, 2026
Merged

Define CLI contracts, enhance npm workflow, and update documentation#15
lahiruudayakumara merged 20 commits into
mainfrom
feat/phase-9-stable-release

Conversation

@lahiruudayakumara

Copy link
Copy Markdown
Contributor

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:

  • Added a standard release automation script (scripts/release.sh) that validates the codebase, builds binaries, packages the npm distribution, generates SHA-256 checksums, and creates annotated git tags.
  • Introduced a detailed release maintainer checklist (docs/contributing/release-checklist.md) outlining pre-release, release, and post-release steps.
  • Overhauled the release process guide (docs/contributing/releases.md) to document the standard release workflow, supported targets, and step-by-step instructions.

Build & CI Improvements:

  • Updated the GitHub Actions workflow (.github/workflows/npm-release.yml) to support cross-compiling for Linux ARM64 by installing the appropriate toolchain and configuring the linker.

Release Notes & Changelog:

  • Updated the changelog (CHANGELOG.md) for the 1.0.0 release, detailing all major features, release tooling, and distribution improvements.

Validation

  • cargo fmt --all --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo test --workspace

Compatibility and security

  • Documentation and compatibility matrix are updated if behavior changed.
  • Threat model or security documentation is updated for new trust boundaries.
  • Persistent format/API changes have an RFC and migration story.
  • Performance claims include reproducible evidence.

@lahiruudayakumara
lahiruudayakumara merged commit 80994c5 into main Aug 29, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant