From d67ddc37b49cd007343850a57dddc05fb3f0859b Mon Sep 17 00:00:00 2001 From: himself65 Date: Fri, 3 Feb 2023 13:57:09 -0600 Subject: [PATCH] docs: add bump blocksuite guideline --- docs/contributing/bump-blocksuite.md | 26 ++++++++++++++++++++++++++ scripts/upgrade-blocksuite.sh | 2 ++ 2 files changed, 28 insertions(+) create mode 100644 docs/contributing/bump-blocksuite.md create mode 100755 scripts/upgrade-blocksuite.sh diff --git a/docs/contributing/bump-blocksuite.md b/docs/contributing/bump-blocksuite.md new file mode 100644 index 0000000000..eb8bbf3493 --- /dev/null +++ b/docs/contributing/bump-blocksuite.md @@ -0,0 +1,26 @@ +# Bump Blocksuite + +```shell +./scripts/upgrade-blocksuite.sh +``` + +## Understand the version number + +### Stable + +You can see all the stable version tags [here](https://github.com/toeverything/blocksuite/tags). + +### Nightly + +If it's nightly version, the version will follow `${version}-${date}-${hash}`. + +For example, `0.4.0-20230203030233-b22bea7` means that +the version is based on `0.4.0`, the building date is `20230203030233`, +and the commit hash is `b22bea7`. + +> For the source code, see [here](https://github.com/toeverything/set-build-version/blob/master/src/version.ts) + +Using this version format, you can easily check the diff between each version. + +For example, the diff from old version `0.4.0-20230201063624-4e0463b` to new version `0.4.0-20230203030233-b22bea7` +is . diff --git a/scripts/upgrade-blocksuite.sh b/scripts/upgrade-blocksuite.sh new file mode 100755 index 0000000000..75338781d2 --- /dev/null +++ b/scripts/upgrade-blocksuite.sh @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +pnpm up "@blocksuite/*" "!@blocksuite/icons" -r -i