Repository navigation
docs(ocm): refresh env and CLI guides and redact internal settings secrets - #398
Merged
Merged
Conversation
Contributor
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
📒 Files selected for processing (9)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Refreshes the environment, contribution, and ocm CLI documentation, and redacts stored credentials from the internal settings API.
.env.exampledocuments previously undocumented options (OPENCODE_HEALTH_*,OPENCODE_BIN,REPO_BROWSE_ROOT,PREVIEW_PORT) and correctsPASSKEY_ORIGINfor Vite dev, the sandbox image digest pin, and theSANDBOX_EXEC_USERdefault.CONTRIBUTING.mdadds type-checking and commit-message conventions;README.mdrefreshes the feature list and theocmCLI description.ocm-cli/README.mdandocm-cli/bin/ocm.tsdocumentocm login, the install layout,--version/--helpand aliases, push/pull safety prompts, the<host> · <repo>indicator, and the/ocm-goaland/ocm-multirunflows.<redacted>; empty values stay empty so a caller can still tell whether a credential is set. Applies to GET and PATCH.scripts/setup-dev.shno longer creates the unusedworkspace/configdirectory.Type of Change
Checklist
pnpm lintpasses locallypnpm typecheckpasses locallyBackend typecheck is clean and
pnpm lintreports 0 errors (41 pre-existingno-explicit-anywarnings).backend/test/routes/internal-settings.test.tspasses (21 tests), including a new case asserting GET redacts stored credentials, keeps empty ones empty, and leaks no secrets; the PATCH test now asserts the response is redacted while the stored value is unchanged.