-
Notifications
You must be signed in to change notification settings - Fork 6
docs(release): explain the 2.0.0 alignment and the FFI publishing-repository change #913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
8dc2ebe
docs(release): explain the 2.0.0 alignment, the FFI repository change…
tobyhede ba3830f
fix(release): correct the alignment note's false claims, and make the…
tobyhede d200ae6
fix(release): resolve the cross-package changelog references, and cor…
tobyhede File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| '@cipherstash/protect-ffi-darwin-x64': patch | ||
| '@cipherstash/protect-ffi-darwin-arm64': patch | ||
| '@cipherstash/protect-ffi-win32-x64-msvc': patch | ||
| '@cipherstash/protect-ffi-linux-x64-gnu': patch | ||
| '@cipherstash/protect-ffi-linux-arm64-gnu': patch | ||
| '@cipherstash/protect-ffi-linux-x64-musl': patch | ||
| --- | ||
|
|
||
| **This is the first release of these packages published from | ||
| `cipherstash/stack`.** Every version up to and including 0.31.0 was published | ||
| from `cipherstash/protectjs-ffi`, which is archived once this release is out. | ||
|
|
||
| If you verify npm provenance, the attested source repository changes with this | ||
| release: | ||
|
|
||
| ``` | ||
| 0.31.0 github.com/cipherstash/protectjs-ffi .github/workflows/release.yml | ||
| 0.32.0 github.com/cipherstash/stack .github/workflows/release.yml | ||
| ``` | ||
|
|
||
| A verification policy that pins the source repository will reject 0.32.0 until | ||
| it is updated. The packages, their contents and their maintainers are otherwise | ||
| unchanged: the Rust source moved into the monorepo at | ||
| `packages/protect-ffi/crates/protect-ffi`, and each of these packages' | ||
| `repository.url` now names `cipherstash/stack`, with `repository.directory` | ||
| pointing at its own stub under `packages/protect-ffi/platforms/`. | ||
|
|
||
| `CHANGELOG.md` is also added to each package's published files, so this note and | ||
| later ones are readable in the package you install rather than only on GitHub. | ||
|
|
||
| The binaries themselves differ from 0.31.0 in one user-visible way: the Rust | ||
| core's `InvariantViolation` message asks the reader to file an issue, and the | ||
| repository it names has moved with the rest. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| '@cipherstash/stack-prisma': patch | ||
| '@cipherstash/protect-ffi': patch | ||
| --- | ||
|
|
||
| Ship `CHANGELOG.md` inside the published tarball. It was missing from `files`, | ||
| so the release notes for these packages were readable on GitHub and on the npm | ||
| web page but not in the package you actually install — which is the copy you | ||
| have when something breaks offline, or when the repository has moved. | ||
|
|
||
| `@cipherstash/stack-drizzle` and `@cipherstash/stack-supabase` gain it in the | ||
| same release, as do the six `@cipherstash/protect-ffi-<platform>` packages. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| 'stash': major | ||
| '@cipherstash/stack': major | ||
| '@cipherstash/stack-drizzle': major | ||
| '@cipherstash/stack-supabase': major | ||
| '@cipherstash/wizard': major | ||
| --- | ||
|
|
||
| **Why this package went to 2.0.0.** The major version number comes from | ||
| `@cipherstash/stack-prisma`, which moves to Prisma Next 0.17 — a breaking change | ||
| for its consumers, with the upgrade steps in its own Major Changes entry. These | ||
| six packages share one version line, so a major in any of them takes all six to | ||
| the same number: | ||
|
|
||
| - `stash` | ||
| - `@cipherstash/stack` | ||
| - `@cipherstash/stack-drizzle` | ||
| - `@cipherstash/stack-supabase` | ||
| - `@cipherstash/stack-prisma` | ||
| - `@cipherstash/wizard` | ||
|
|
||
| They are versioned together on purpose. `stash init` pins the versions of the | ||
| packages it installs and the CLI embeds that map at build time, so a package | ||
| shipping alone would leave the CLI recommending versions that no longer match | ||
| what is published, and warning about a skew it had itself created. | ||
|
|
||
| **This does not mean every package in the release is drop-in.** The version | ||
| number is shared; the changes are not. Two changes elsewhere in this release | ||
| need action from some users, and neither is filed under Major Changes — each is | ||
| recorded at the level its own author judged correct. They are named here so you | ||
| do not have to read six changelogs to find them: | ||
|
|
||
| - **`@cipherstash/stack` — `clientKey` is hex-only.** A decoder fallback that | ||
| also accepted standard padded base64 is gone, and such a key is now rejected | ||
| at client construction with `invalid clientKey: expected a hex-encoded key`. | ||
| Hex is what `stash env` emits and what the docs have always specified, so most | ||
| callers are unaffected; a key pasted out of `~/.cipherstash/secretkey.json` | ||
| (which stores base64) is not. The full entry is "Adopt protect-ffi 0.31.0" in | ||
| the **`@cipherstash/stack`** changelog; it also narrows which `error.code` | ||
| values DynamoDB operations report. | ||
| - **`stash` — `stash eql validate` lost `--exclude-operator-family`,** and two | ||
| checks that used to exit 1 no longer do. A script passing that flag, or a CI | ||
| gate relying on those exit codes, needs updating. The full entry is under | ||
| `eql validate` in the **`stash`** changelog. | ||
|
|
||
| If you use neither `@cipherstash/stack-prisma` nor either of those, upgrading | ||
| 1.x → 2.0.0 needs no code changes. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # @cipherstash/cli | ||
| # stash | ||
|
|
||
| ## 1.0.0 | ||
|
|
||
|
|
||
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # @cipherstash/prisma-next | ||
| # @cipherstash/stack-prisma | ||
|
|
||
| ## 1.0.0 | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,7 +62,8 @@ | |
| "files": [ | ||
| "dist", | ||
| "src", | ||
| "README.md" | ||
| "README.md", | ||
| "CHANGELOG.md" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsup", | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still feel conflicted about this. Prisma Next went from 0.16 to 0.17 but we are going from 1.0.0 to 2.0.0. Worth mentioning that Prisma Next will eventually be released as Prisma 8.0.0.
Versions. What even are they.