docs: add release runbook and document npm install#3
Merged
Conversation
…README Add RELEASING.md, a release-manager guide for the @apache-doris npm release process: version source, the Automation-token / scoped-name / chmod requirements, dry-run validation, tagging, verification, and troubleshooting. Add an Install section to the README presenting `npm install -g @apache-doris/doriscli` as the recommended install method, with build-from-source kept as the fallback. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
RELEASING.md(new) — a release-manager runbook for publishing the CLI to npm.README.md— adds an Install section presentingnpm install -g @apache-doris/dorisclias the recommended install method.RELEASING.mdcovers@apache-doris/*packages) and how npm resolves the right platform binaryCargo.toml; npm versions are immutableNPM_TOKEN,apache-dorisorg membershipchmod 0755step (actions/upload-artifactstrips the executable bit — this is what made0.1.0ship broken) and the Actions-allowlist constraintEACCES/ lockfile) and how to recover a broken releaseREADME.md## Buildheading is unchanged, so existing#buildlinks (npm package README + launcher error message) still resolve.🤖 Generated with Claude Code