Skip to content

Commit b288422

Browse files
document github versioning
1 parent 6c4f8ee commit b288422

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ nbb-logseq -e '(+ 1 2 3)'
3636

3737
## Database Version
3838

39-
To use `nbb-logseq` with [the database version](https://github.com/logseq/logseq#-database-version), specify the version as `logseq/nbb-logseq#feat-db-v28`. This version is only available through github and has not been released to npm. An npm version will be released when the database version has a desktop release.
39+
To use `nbb-logseq` with [the database version](https://github.com/logseq/logseq#-database-version), specify the version as `logseq/nbb-logseq#feat-db-v29`. This version is only available through github and has not been released to npm. An npm version will be released when the database version has a desktop release.
4040

4141
Unlike file graphs, DB graphs can be written by scripts. This is powerful and opens up more use cases for scripting. To write your own script, you'll need a package.json and nbb.edn. Use [this example package.json](https://github.com/logseq/publish-spa/blob/feat/db/package.json) and [this example nbb.edn](https://github.com/logseq/publish-spa/blob/feat/db/nbb.edn). Some example database graph scripts:
4242

@@ -144,13 +144,23 @@ To QA that your branch works as expected on a dependent repository e.g.
144144
* `yarn add /path/to/nbb-logseq` in a dependent's repo.
145145
* Run `yarn nbb-logseq FILE.cljs` to run a given file. The graph-parser can confirm all it's namespaces load nbb-logseq with `bb test:load-all-namespaces-with-nbb`.
146146

147-
### Release process
147+
### DB Release process
148+
149+
Until the [database version](#database-version) has a desktop release, `nbb-logseq` uses github versioning. With github versioning, releases are quick and the release is built locally on a developer's machine. To build a new version:
150+
151+
1. Increment version of `package.json` e.g. `1.2.173-feat-db-v29` to `1.2.173-feat-db-v30`
152+
2. `npm i` to update `package-lock.json`.
153+
3. `rm -rf .shadow-cljs && NBB_CLI_NAME=nbb-logseq NBB_NPM_LIB_NAME='@logseq/nbb-logseq' bb release`
154+
4. Git commit all changes including package* and lib/* changes.
155+
5. `git tag` the commit e.g. `git tag feat-db-v30` and git push the new tag and commit.
156+
157+
Once the desktop release occurs, nbb-logseq changes should be fewer and we can go back to the [NPM release process](#npm-release-process).
158+
159+
### NPM Release process
148160

149161
Steps to publish a new npm package:
150162

151163
1. Update CHANGELOG.md if anything specific to nbb-logseq has been updated.
152164
2. Update nbb with `bb update-nbb` on https://github.com/babashka/nbb-features and confirm CI passes.
153165
* This is done to confirm that datascript and datascript-transit tests pass.
154-
3. Update nbb with `bb update-nbb` on this repo and confirm CI passes.
155-
* This is done to run the test suite passes which includes cljs-time tests.
156-
4. Run `bb publish X.Y.Z` where X.Y.Z is the version to publish. Push to github to publish.
166+
3. Update nbb with `bb update-nbb` on this repo and confirm CI passes.

0 commit comments

Comments
 (0)