Skip to content

Commit 7aff418

Browse files
committed
Add Changesets for versioning and release management, update package.json files to include 'files' and 'publishConfig' fields for public access, and enhance README with logo
1 parent 048fe8d commit 7aff418

11 files changed

Lines changed: 906 additions & 0 deletions

File tree

.changeset/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
4+
with multi-package repos, or single-package repos to help you version and publish your code. You can
5+
find the full documentation for it [in our repository](https://github.com/changesets/changesets).
6+
7+
We have a quick list of common questions to get you started engaging with this project in
8+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md).

.changeset/config.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@3.1.3/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch",
10+
"ignore": []
11+
}

.changeset/wicked-turtles-sleep.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@codemix/graph": patch
3+
"@codemix/text-search": patch
4+
"@codemix/y-graph-storage": patch
5+
---
6+
7+
Add npm publishing metadata and automated release configuration for the monorepo packages.

.github/workflows/release.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
concurrency:
10+
group: release-${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
permissions:
14+
contents: write
15+
pull-requests: write
16+
id-token: write
17+
18+
jobs:
19+
release:
20+
runs-on: ubuntu-latest
21+
timeout-minutes: 30
22+
steps:
23+
- uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
27+
- uses: pnpm/action-setup@v4
28+
with:
29+
version: 10
30+
31+
- uses: actions/setup-node@v4
32+
with:
33+
node-version: 22
34+
cache: pnpm
35+
registry-url: https://registry.npmjs.org
36+
37+
- name: Install dependencies
38+
run: pnpm install --frozen-lockfile
39+
40+
- name: Create release PR or publish
41+
uses: changesets/action@v1
42+
with:
43+
version: pnpm version-packages
44+
publish: pnpm release
45+
commit: "chore: version packages"
46+
title: "chore: version packages"
47+
env:
48+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
49+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="center">
2+
<img src="./codemix-logo.png" alt="codemix" width="240" />
3+
</p>
4+
15
# @codemix/graph
26

37
A fully type-safe, TypeScript-first in-memory property graph database with a Cypher query language parser, a **type-safe [TinkerPop](https://tinkerpop.apache.org/) / [Gremlin](https://tinkerpop.apache.org/docs/current/reference/#gremlin)-style traversal API** (`GraphTraversal`), multiple index types, and pluggable storage adapters including a [Yjs](https://yjs.dev/) CRDT-based adapter for collaborative/realtime/offline-first use.

codemix-logo.png

14.5 KB
Loading

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
],
1111
"scripts": {
1212
"build": "pnpm run -r build",
13+
"changeset": "changeset",
14+
"version-packages": "changeset version",
15+
"release": "pnpm build && changeset publish",
1316
"typecheck": "pnpm run -r typecheck",
1417
"test": "vitest",
1518
"test:coverage": "vitest run --coverage",
@@ -19,6 +22,7 @@
1922
"format:check": "oxfmt --check ."
2023
},
2124
"devDependencies": {
25+
"@changesets/cli": "^2.30.0",
2226
"@vitest/coverage-istanbul": "catalog:",
2327
"oxfmt": "^0.44.0",
2428
"oxlint": "^1.59.0",

packages/graph/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
"version": "0.0.1",
44
"description": "The codemix graph database.",
55
"license": "MIT",
6+
"files": [
7+
"dist"
8+
],
69
"type": "module",
710
"types": "./dist/index.d.ts",
811
"exports": {
@@ -13,6 +16,9 @@
1316
}
1417
}
1518
},
19+
"publishConfig": {
20+
"access": "public"
21+
},
1622
"scripts": {
1723
"build": "pnpm run build:grammar && tsc",
1824
"build:grammar": "peggy --format es src/grammar.peggy -o src/grammar.js --dts --return-types '{\"MultiStatement\": \"import('\\''./AST.js'\\'').Query | import('\\''./AST.js'\\'').UnionQuery | import('\\''./AST.js'\\'').MultiStatement\", \"CypherStatement\": \"import('\\''./AST.js'\\'').Query | import('\\''./AST.js'\\'').UnionQuery\"}' && mkdir -p dist && cp src/grammar.* dist",

packages/text-search/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
"version": "0.0.1",
44
"description": "Fast, accurate text search with BM25 scoring and stemming.",
55
"license": "MIT",
6+
"files": [
7+
"dist"
8+
],
69
"type": "module",
710
"types": "./dist/index.d.ts",
811
"exports": {
@@ -13,6 +16,9 @@
1316
}
1417
}
1518
},
19+
"publishConfig": {
20+
"access": "public"
21+
},
1622
"scripts": {
1723
"build": "tsc",
1824
"typecheck": "tsc --noEmit",

packages/y-graph-storage/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
"version": "0.0.1",
44
"description": "A YJS storage adapter for the codemix graph database.",
55
"license": "MIT",
6+
"files": [
7+
"dist"
8+
],
69
"type": "module",
710
"types": "./dist/index.d.ts",
811
"exports": {
@@ -13,6 +16,9 @@
1316
}
1417
}
1518
},
19+
"publishConfig": {
20+
"access": "public"
21+
},
1622
"scripts": {
1723
"build": "tsc",
1824
"typecheck": "tsc --noEmit",

0 commit comments

Comments
 (0)