ceramicnetwork · dav1do · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,87 @@
+# Development
+
+> Getting started with development on ceramic-sdk
+
+## Project setup
+
+First clone the repo:
+
+```
+git clone https://github.com/ceramicnetwork/ceramic-sdk.git
+cd ceramic-sdk
+```
+
+This monorepo uses pnpm, make sure to install it first if you don't already have it.
+
+```
+npm install -g pnpm
+```
+
+To install dependencies for all packages in this repo:
+
+```
+pnpm install
+```
+
+Then build all packages:
+
+```
+pnpm run build
+```
+
+## Run tests
+
+You can run all tests at the top level,
+
+```
+pnpm test
+```
+
+If you only want to test a specific package just `cd` into the specific package folder and run the same command as above.
+
+## Documenting changes
+
+ceramic-sdk uses [changesets](https://github.com/changesets/changesets) to keep track of and release changes.
+
+To generate a new changeset, run `pnpm changeset` in the root of the repository and follow the instructions.
+The generated markdown files in the `.changeset` directory should be committed to the repository.
+
+## Creating a release
+
+This repo uses pnpm to make releases, each package is released and versioned individually. [Semantic versioning](https://semver.org/) is followed to version releases. We do not currently regularly make releases on schedule or make release candidates (alpha/beta). Releases are made when changes are available to release. Released packages are published to NPM.
+
+Before creating any releases, make sure you have an npm account (you can sign up at https://www.npmjs.com/), have signed into that account on the command line with `npm adduser`, and that the account has been added to the ceramic-sdk org on npm.
+
+### Release
+
+Releases are currently done manually and not by any CI. CI will only publish documentation on release. Process may be further formalized in the future. To make a release:
+
+1. First create a release branch from the lastest main branch.
+
+```
+git checkout -b release/any-name
+```
+
+2. Run `pnpm changeset version`. This will bump the versions of the packages previously specified with pnpm changeset (and any dependents of those) and update the changelog files.
+
+3. Manually update the flight-sql-client/npm/*/package.json versions if desired. This isn't yet included with the changeset. You must download the artifacts from CI, put them in `flight-sql-client/artifacts` and `run pnpm artifacts` to move them to the platform packages similar to how the CI workfow step `Publish flight-sql-client` does this, but it isn't yet released.
+
+4. Run `pnpm lint && pnpm install`. This will update the lockfile and rebuild packages.
+
+5. Create release commit, include each package and version to be released, for example:
+
+```
+git commit -m @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected], @ceramic-sdk/[email protected]
+```
+
+6. Push and open PR, request review and make sure all github checks pass before merging.
+
+7. Once merged, pull main branch locally, make sure it is up to date and all latest dependencies from the lock file are installed.
+
+```
+git checkout main
+git pull
+pnpm install --frozen-lockfile
+```
+
+8. Run `pnpm publish -r --access public` to publish all the updated and newly created packages. The publish command will build the packages and run some checks before publishing to NPM. You can use `--dry-run` to verify before publishing, as well as `--tag next` if you want a prerelease.
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.2",
+    "@changesets/cli": "^2.27.1",
     "@jest/globals": "^29.7.0",
     "@skypack/package-check": "^0.2.2",
     "@swc/cli": "^0.4.0",

diff --git a/packages/events/CHANGELOG.md b/packages/events/CHANGELOG.md
@@ -0,0 +1,12 @@
+# @ceramic-sdk/events
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
diff --git a/packages/events/package.json b/packages/events/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/events",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "events"],

diff --git a/packages/flight-sql-client/CHANGELOG.md b/packages/flight-sql-client/CHANGELOG.md
@@ -0,0 +1,7 @@
+# @ceramic-sdk/flight-sql-client
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates. Match other package versions.
diff --git a/packages/flight-sql-client/npm/darwin-arm64/package.json b/packages/flight-sql-client/npm/darwin-arm64/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/flight-sql-client-darwin-arm64",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "os": ["darwin"],
   "cpu": ["arm64"],
   "main": "flight-sql-client.darwin-arm64.node",

diff --git a/packages/flight-sql-client/npm/darwin-x64/package.json b/packages/flight-sql-client/npm/darwin-x64/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/flight-sql-client-darwin-x64",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "os": ["darwin"],
   "cpu": ["x64"],
   "main": "flight-sql-client.darwin-x64.node",

diff --git a/packages/flight-sql-client/npm/linux-x64-gnu/package.json b/packages/flight-sql-client/npm/linux-x64-gnu/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/flight-sql-client-linux-x64-gnu",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "os": ["linux"],
   "cpu": ["x64"],
   "main": "flight-sql-client.linux-x64-gnu.node",

diff --git a/packages/flight-sql-client/package.json b/packages/flight-sql-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/flight-sql-client",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "A FlightSQL client. Currently only supports Node.js",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/packages/http-client/CHANGELOG.md b/packages/http-client/CHANGELOG.md
@@ -0,0 +1,12 @@
+# @ceramic-sdk/http-client
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
diff --git a/packages/http-client/package.json b/packages/http-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/http-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "http", "client"],

diff --git a/packages/identifiers/CHANGELOG.md b/packages/identifiers/CHANGELOG.md
@@ -0,0 +1,7 @@
+# @ceramic-sdk/identifiers
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
diff --git a/packages/identifiers/package.json b/packages/identifiers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/identifiers",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "identifiers"],

diff --git a/packages/model-client/CHANGELOG.md b/packages/model-client/CHANGELOG.md
@@ -0,0 +1,15 @@
+# @ceramic-sdk/model-client
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-client/package.json b/packages/model-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "stream", "model", "client"],

diff --git a/packages/model-handler/CHANGELOG.md b/packages/model-handler/CHANGELOG.md
@@ -0,0 +1,13 @@
+# @ceramic-sdk/model-handler
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-handler/package.json b/packages/model-handler/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-handler",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",

diff --git a/packages/model-instance-client/CHANGELOG.md b/packages/model-instance-client/CHANGELOG.md
@@ -0,0 +1,15 @@
+# @ceramic-sdk/model-instance-client
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-instance-client/package.json b/packages/model-instance-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-instance-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "stream", "model", "document", "client"],

diff --git a/packages/model-instance-handler/CHANGELOG.md b/packages/model-instance-handler/CHANGELOG.md
@@ -0,0 +1,14 @@
+# @ceramic-sdk/model-instance-handler
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-instance-handler/package.json b/packages/model-instance-handler/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-instance-handler",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",

diff --git a/packages/model-instance-protocol/CHANGELOG.md b/packages/model-instance-protocol/CHANGELOG.md
@@ -0,0 +1,13 @@
+# @ceramic-sdk/model-instance-protocol
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-instance-protocol/package.json b/packages/model-instance-protocol/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-instance-protocol",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "stream", "model", "document"],

diff --git a/packages/model-protocol/CHANGELOG.md b/packages/model-protocol/CHANGELOG.md
@@ -0,0 +1,13 @@
+# @ceramic-sdk/model-protocol
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/model-protocol/package.json b/packages/model-protocol/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/model-protocol",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "stream", "model"],

diff --git a/packages/stream-client/CHANGELOG.md b/packages/stream-client/CHANGELOG.md
@@ -0,0 +1,13 @@
+# @ceramic-sdk/stream-client
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
+
+### Patch Changes
+
+- Updated dependencies
+  - @ceramic-sdk/[email protected]
+  - @ceramic-sdk/[email protected]
diff --git a/packages/stream-client/package.json b/packages/stream-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/stream-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "stream", "client"],

diff --git a/packages/test-utils/CHANGELOG.md b/packages/test-utils/CHANGELOG.md
@@ -0,0 +1,7 @@
+# @ceramic-sdk/test-utils
+
+## 0.2.0
+
+### Minor Changes
+
+- Release all packages with recent updates
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ceramic-sdk/test-utils",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "3Box Labs",
   "license": "(Apache-2.0 OR MIT)",
   "keywords": ["ceramic", "test"],