Beautiful, AI-native markdown IDE and LLM wiki
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 the repository
What is a changeset? A changeset is a piece of information about changes made in a branch or commit. It holds three bits of information:
- What we need to release
- What version we are releasing packages at (using a semver bump type)
- A changelog entry for the released packages
Click here to learn what changesets are, and how to add one.
Click here if you want to understand how to contribute when changesets are used.
Follow the changelog authoring and review policy when writing release notes.
Open Knowledge convention — pre-1.0 bump types
While Open Knowledge is pre-1.0, NEVER declare a major bump in a changeset. OK uses a modified semver where the bump types map differently:
| What you want to communicate | OK pre-1.0 bump type |
|---|---|
| Breaking change for consumers (rename, removal, schema) | minor |
| New feature, additive API surface | minor |
| Bug fix, internal change, no user-visible API impact | patch |
Why: under standard semver, going from 0.X.Y to 1.0.0 is a once-in-a-product-lifetime decision. Until OK explicitly takes a major (decided by the team, not by an individual changeset), every change is either minor (new behavior or breaking change) or patch (bug fix / refinement). This lets us ship breaking changes without prematurely advertising a 1.0 stability promise.
Mechanic: the OK fixed-group (@inkeep/open-knowledge, -core, -server, -app, -desktop) bumps in lock-step on the highest declared bump type across all queued changesets. A single major declaration on any one package pulls the entire group to 1.0.0 — once. Don't be that changeset.
When 1.0.0 does eventually ship, this convention will be retired and standard semver resumes.
Authoring tip: run
pnpm changesetfrom anywhere underpublic/open-knowledge/— the CLI walks up to find this folder. Don't hand-create files; the tool's interactive flow asks for bump types in order and writes a well-formed frontmatter block. Per the convention above, only pickminororpatch.
Nothing on
maincarries a release version: the packages commit0.0.0-unknown, and each release stamps its version from the tag at build time. A changeset is deleted frommainby the daily cleanup once a published stable carries it.