feat(storage): Phase 5 — Release v0.1.0 (docs, budgets, pre-publish gate) - #7
Merged
Conversation
….yml verified (5.4, 5.5)
Measured brotli sizes: server 14,836 B / shared 584 B. Budgets tightened ~15% from 30,000/3,500 to 17,000/700. Tarball verified: only dist/ + metadata (README, CHANGELOG, LICENSE, package.json).
Version bumped to 0.1.0. CHANGELOG dated 2026-07-01. prepublishOnly: typecheck OK, lint OK (0 errors), 310 tests 100% line/branch coverage, build (server + shared, both subpaths ESM+CJS+.d.ts), size OK (server 14,836 B brotli / 17,000 B budget; shared 584 B brotli / 700 B budget). Invariant gate: no signatureVersion / maxRetries in src/.
There was a problem hiding this comment.
Pull request overview
This PR prepares @bymax-one/nest-storage for the v0.1.0 release by adding public-facing documentation/release artifacts, tightening bundle-size gates, and updating the package version for publication.
Changes:
- Adds release artifacts and project docs (README, CHANGELOG, SECURITY policy, LICENSE, mutation testing plan/results, agent/architecture docs).
- Tightens brotli size budgets in
scripts/check-size.mjsand documents the release gate results. - Bumps
package.jsonversion to0.1.0and updates planning/task dashboards to reflect Phase 5 completion progress.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Adds security policy, disclosure process, and storage-specific security goals/notes. |
| scripts/check-size.mjs | Tightens brotli bundle budgets for server/shared outputs. |
| README.md | Adds full public README with quick starts, configuration, provider notes, and error catalog. |
| package.json | Bumps version to 0.1.0 for release. |
| LICENSE | Adds MIT license for distribution. |
| docs/tasks/README.md | Updates phase/task dashboard progress for Phase 5. |
| docs/tasks/phase-05-release.md | Marks Phase 5 tasks as done and records release gate outcomes. |
| docs/mutation_testing_results.md | Documents v0.1.0 mutation testing release-gate results. |
| docs/mutation_testing_plan.md | Adds mutation testing strategy, thresholds, and critical paths. |
| docs/development_plan.md | Updates overall project progress and phase dashboard to Phase 5 completion state. |
| CLAUDE.md | Adds agent quick reference, repo standards, and quality gates. |
| CHANGELOG.md | Adds Keep a Changelog-format changelog with v0.1.0 entry. |
| AGENTS.md | Adds architecture deep dive and operational/design rationale. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…pared (publish pending)
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
Changes
Release artifacts
README.md— full public documentation with provider-compat callout (the docs(repo): add autonomous phase-execution runbook for agents #1 trap: non-AWS CRC32 checksum headers),maxAttempts(nevermaxRetries), 17-code error catalogCHANGELOG.md— Keep a Changelog 1.1.0, v0.1.0 entry with all features listedSECURITY.md— supported versions, responsible disclosure (security@bymax.one), storage-specific security goals, sensitive code paths tableLICENSE— MIT, Copyright 2026 Bymax OneAgent documentation
CLAUDE.md— 9 critical rules, architecture summary, quality gates, code standards, context7 guidelinesAGENTS.md— architecture deep-dive: dynamic module, S3Client lifecycle, KeyResolverService, validation pipeline, signed-URL TTL clamp, LRU idempotency cache, provider recipes, error catalogBuild tooling
scripts/check-size.mjs— brotli budgets tightened from 30,000/3,500 to 17,000/700 (measured: 14,836/584)package.json— version0.1.0-alpha.0→0.1.0Test plan
pnpm typecheck— 0 errorspnpm lint— 0 errors (run withNODE_OPTIONS="--max-old-space-size=4096"if needed)pnpm test:cov— 310 tests, 100% line/branch on all 25 suitespnpm build && pnpm size— both subpaths within brotli budgetpackage.json"version": "0.1.0","dependencies": {}signatureVersion/maxRetriesinsrc/v0.1.0to triggerrelease.yml(OIDC Trusted Publishing — no NPM_TOKEN)Do NOT
v0.1.0tag before merging this PRpnpm publishmanually — the release.yml workflow owns that