feat: update docs (#413)

* feat: add alert message

* chore(versions): 😊 publish v0.7.0-alpha.61

* fix(create-nocobase-app): add storage folder

* fix(docs): storage path error

* chore(versions): 😊 publish v0.7.0-alpha.62

* docs: update upgrading

* docs: update release notes
This commit is contained in:
chenos 2022-05-23 18:48:15 +08:00 committed by GitHub
parent f0d0afbb19
commit c851033406
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 135 additions and 102 deletions

View File

@ -4,7 +4,7 @@ networks:
driver: bridge
services:
app:
image: nocobase/nocobase:latest
image: nocobase/nocobase:0.7.0-alpha.62
networks:
- nocobase
depends_on:

View File

@ -4,7 +4,7 @@ networks:
driver: bridge
services:
app:
image: nocobase/nocobase:latest
image: nocobase/nocobase:0.7.0-alpha.62
networks:
- nocobase
environment:

View File

@ -4,7 +4,7 @@ networks:
driver: bridge
services:
app:
image: nocobase/nocobase:latest
image: nocobase/nocobase:0.7.0-alpha.62
networks:
- nocobase
environment:

View File

@ -15,7 +15,7 @@ The directory structure of the application scaffold created by `create-nocobase-
├── client # Client-side modules
├── server # Server-side modules
├── plugins # Plugins directory
├── storages # For database files, attachments, cache, etc.
├── storage # For database files, attachments, cache, etc.
├── db
├── .env # Environment variables
├── .buildrc.ts # Packaging configuration for packages, supports cjs, esm and umd packaging.

View File

@ -1,5 +1,11 @@
# Upgrading
<Alert>
This document only applies to versions after v0.7.0-alpha.57. Projects created before need to be recreated.
</Alert>
Make sure to back up your database before upgrading
## Docker
@ -15,13 +21,17 @@ cd nocobase/docker/app-mysql
cd nocobase/docker/app-postgres
```
Use `docker-compose` to stop, delete the application, and download the latest image
In the `docker-compose.yml` file, replace the image of the app container with the latest version
```yml
services:
app:
image: nocobase/nocobase:0.7.0-alpha.62
```
Download the image and start it
```bash
# Stop the app
docker-compose stop app
# Delete the app
docker-compose rm app
# Download the latest image and start it
docker-compose up -d app
# Check the status of the app process

View File

@ -2,6 +2,8 @@
## 2022/05/23 ~ v0.7.0-alpha.59
- feat(docs): add alert message
- fix(create-nocobase-app): storage path error
- fix(client): improve translation
- fix(cli): nocobase test command --db-clean option is invalid
- refactor(plugin-workflow): change column type of executed from boolean to integer (#411)
@ -35,6 +37,10 @@
- create scaffolding `create-nocobase-app`
- Documents theme `dumi-theme-nocobase`
### Breaking changes
📢 Previously created projects need to be recreated.
## 2022/05/14 ~ v0.7.0-alpha.34
- feat: add plugins:getPinned action api

View File

@ -15,7 +15,7 @@ $ yarn create nocobase-app my-nocobase-app
├── client # 客户端模块
├── server # 服务端模块
├── plugins # 插件目录
├── storages # 用于存放数据库文件、附件、缓存等
├── storage # 用于存放数据库文件、附件、缓存等
├── db
├── .env # 环境变量
├── .buildrc.ts # packages 的打包配置,支持 cjs、esm 和 umd 三种格式的打包。

View File

@ -1,5 +1,11 @@
# 升级
<Alert>
此篇升级文档只适用于 v0.7.0-alpha.57 之后的版本,在此之前创建的项目需要重新创建。
</Alert>
升级前请务必将数据库数据进行备份
## Docker
@ -15,14 +21,17 @@ cd nocobase/docker/app-mysql
cd nocobase/docker/app-postgres
```
使用 `docker-compose` 停止、删除应用,并下载最新镜像
`docker-compose.yml` 文件app 容器的 image 替换为最新版本
```yml
services:
app:
image: nocobase/nocobase:0.7.0-alpha.62
```
下载最新镜像并启动容器
```bash
# 停止应用
docker-compose stop app
# 删除应用
docker-compose rm app
# 下载最新镜像并启动
docker-compose up -d app
# 查看 app 进程的情况
docker-compose logs app

View File

@ -1,7 +1,9 @@
# 更新日志
## 2022/05/23 ~ v0.7.0-alpha.59
## 2022/05/23 ~ v0.7.0-alpha.62
- feat(docs): add alert message
- fix(create-nocobase-app): storage path error
- fix(client): improve translation
- fix(cli): nocobase test command --db-clean option is invalid
- refactor(plugin-workflow): change column type of executed from boolean to integer (#411)
@ -37,6 +39,10 @@
- 改进 create 脚手架 `create-nocobase-app`
- 官网文档主题 `dumi-theme-nocobase`
### Breaking changes
📢 在此之前创建的项目需要重新创建。
## 2022/05/14 ~ v0.7.0-alpha.34
- feat: add plugins:getPinned action api

View File

@ -1,5 +1,5 @@
{
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"npmClient": "yarn",
"useWorkspaces": true,
"npmClientArgs": [

View File

@ -1,7 +1,6 @@
import { getUmiConfig, resolveNocobasePackagesAlias } from '@nocobase/devtools/umiConfig';
import { defineConfig } from 'umi';
const packageJson = require('./package.json');
const umiConfig = getUmiConfig();
process.env.MFSU_AD = 'none';
@ -9,8 +8,6 @@ process.env.MFSU_AD = 'none';
export default defineConfig({
hash: true,
define: {
'process.env.APP_ENV': process.env.APP_ENV,
'process.env.VERSION': packageJson?.devDependencies?.['@nocobase/client'],
...umiConfig.define,
},
// only proxy when using `umi dev`

View File

@ -1,9 +1,9 @@
{
"name": "@nocobase/app-client",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"license": "MIT",
"devDependencies": {
"@nocobase/client": "0.7.0-alpha.60"
"@nocobase/client": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,12 +1,12 @@
{
"name": "@nocobase/app-server",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "MIT",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"dependencies": {
"@nocobase/preset-nocobase": "0.7.0-alpha.60"
"@nocobase/preset-nocobase": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/acl",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -12,7 +12,7 @@
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"dependencies": {
"@nocobase/resourcer": "0.7.0-alpha.60",
"@nocobase/resourcer": "0.7.0-alpha.62",
"json-templates": "^4.2.0"
},
"repository": {

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/actions",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -12,8 +12,8 @@
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"dependencies": {
"@nocobase/database": "0.7.0-alpha.60",
"@nocobase/resourcer": "0.7.0-alpha.60"
"@nocobase/database": "0.7.0-alpha.62",
"@nocobase/resourcer": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/build",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "Library build tool based on rollup.",
"main": "lib/index.js",
"bin": {

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/cli",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -23,7 +23,7 @@
"serve": "^13.0.2"
},
"devDependencies": {
"@nocobase/devtools": "0.7.0-alpha.60"
"@nocobase/devtools": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/client",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"license": "Apache-2.0",
"licenses": [
{
@ -18,7 +18,7 @@
"@formily/antd": "2.0.20",
"@formily/core": "2.0.20",
"@formily/react": "2.0.20",
"@nocobase/utils": "0.7.0-alpha.60",
"@nocobase/utils": "0.7.0-alpha.62",
"ahooks": "^3.0.5",
"antd": "~4.19.5",
"axios": "^0.26.1",

View File

@ -1,6 +1,6 @@
{
"name": "create-nocobase-app",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "src/index.js",
"license": "Apache-2.0",
"licenses": [

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/database",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
@ -12,7 +12,7 @@
}
],
"dependencies": {
"@nocobase/utils": "0.7.0-alpha.60",
"@nocobase/utils": "0.7.0-alpha.62",
"async-mutex": "^0.3.2",
"deepmerge": "^4.2.2",
"flat": "^5.0.2",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/devtools",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -11,7 +11,7 @@
],
"main": "./src/index.js",
"dependencies": {
"@nocobase/build": "0.7.0-alpha.60",
"@nocobase/build": "0.7.0-alpha.62",
"@testing-library/react": "^12.1.2",
"@types/jest": "^26.0.0",
"@types/koa": "^2.13.4",

View File

@ -1,5 +1,8 @@
const { existsSync } = require('fs');
const { resolve } = require('path');
const packageJson = require('./package.json');
console.log('VERSION: ', packageJson?.version);
function getUmiConfig() {
const { APP_PORT, API_BASE_URL } = process.env;
@ -23,6 +26,8 @@ function getUmiConfig() {
return {
define: {
'process.env.API_BASE_URL': API_BASE_URL || API_BASE_PATH,
'process.env.APP_ENV': process.env.APP_ENV,
'process.env.VERSION': packageJson?.version,
},
// only proxy when using `umi dev`
// if the assets are built, will not proxy

View File

@ -1,6 +1,6 @@
{
"name": "dumi-theme-nocobase",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"private": true,
"files": [
"es",

View File

@ -219,8 +219,8 @@
// images
img {
max-width: 1000px;
@media @mobile {
width: 100%;
@media only screen and (max-width: 1400px) {
max-width: 100%;
}
}
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/resourcer",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/sdk",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"license": "Apache-2.0",
"licenses": [
{

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/server",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"types": "./lib/index.d.ts",
"license": "Apache-2.0",
@ -13,10 +13,10 @@
"dependencies": {
"@koa/cors": "^3.1.0",
"@koa/router": "^9.4.0",
"@nocobase/acl": "0.7.0-alpha.60",
"@nocobase/actions": "0.7.0-alpha.60",
"@nocobase/database": "0.7.0-alpha.60",
"@nocobase/resourcer": "0.7.0-alpha.60",
"@nocobase/acl": "0.7.0-alpha.62",
"@nocobase/actions": "0.7.0-alpha.62",
"@nocobase/database": "0.7.0-alpha.62",
"@nocobase/resourcer": "0.7.0-alpha.62",
"chalk": "^4.1.1",
"commander": "^9.2.0",
"find-package-json": "^1.2.0",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/test",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"types": "./lib/index.d.ts",
"license": "Apache-2.0",
@ -11,7 +11,7 @@
}
],
"dependencies": {
"@nocobase/server": "0.7.0-alpha.60",
"@nocobase/server": "0.7.0-alpha.62",
"@types/supertest": "^2.0.11",
"mockjs": "^1.1.0",
"mysql2": "^2.3.3",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/utils",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"types": "./lib/index.d.ts",
"license": "Apache-2.0",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-acl",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -12,9 +12,9 @@
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"dependencies": {
"@nocobase/acl": "0.7.0-alpha.60",
"@nocobase/database": "0.7.0-alpha.60",
"@nocobase/server": "0.7.0-alpha.60"
"@nocobase/acl": "0.7.0-alpha.62",
"@nocobase/database": "0.7.0-alpha.62",
"@nocobase/server": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-action-logs",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"license": "Apache-2.0",
@ -11,7 +11,7 @@
}
],
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-china-region",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -13,7 +13,7 @@
"china-division": "^2.4.0"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-client",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -10,10 +10,10 @@
}
],
"dependencies": {
"@nocobase/server": "0.7.0-alpha.60"
"@nocobase/server": "0.7.0-alpha.62"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-collection-manager",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -10,7 +10,7 @@
}
],
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-error-handler",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"description": "",
"license": "Apache-2.0",
"licenses": [
@ -13,7 +13,7 @@
"types": "./lib/index.d.ts",
"dependencies": {
"@formily/json-schema": "^2.0.15",
"@nocobase/server": "0.7.0-alpha.60"
"@nocobase/server": "0.7.0-alpha.62"
},
"repository": {
"type": "git",

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-file-manager",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -11,7 +11,7 @@
],
"dependencies": {
"@koa/multer": "^3.0.0",
"@nocobase/server": "0.7.0-alpha.60",
"@nocobase/server": "0.7.0-alpha.62",
"aws-sdk": "^2.2.32",
"koa-static": "^5.0.0",
"mime-match": "^1.0.2",
@ -21,7 +21,7 @@
"multer-s3": "^2.10.0"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60",
"@nocobase/test": "0.7.0-alpha.62",
"@types/koa-multer": "^1.0.1",
"@types/multer": "^1.4.5"
},

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-multi-app-manager",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -10,7 +10,7 @@
}
],
"dependencies": {
"@nocobase/server": "0.7.0-alpha.60"
"@nocobase/server": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-notifications",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -13,7 +13,7 @@
"nodemailer": "^6.6.1"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60",
"@nocobase/test": "0.7.0-alpha.62",
"@types/nodemailer": "6.4.4",
"nodemailer-mock": "^1.5.11"
},

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-system-settings",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -10,7 +10,7 @@
}
],
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-ui-routes-storage",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -13,7 +13,7 @@
"flat-to-nested": "^1.1.1"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-ui-schema-storage",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -11,7 +11,7 @@
],
"devDependencies": {
"@formily/json-schema": "2.0.20",
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-users",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -13,7 +13,7 @@
"jsonwebtoken": "^8.5.1"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60",
"@nocobase/test": "0.7.0-alpha.62",
"@types/jsonwebtoken": "^8.5.8"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/plugin-workflow",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"main": "lib/index.js",
"license": "Apache-2.0",
"licenses": [
@ -10,14 +10,14 @@
}
],
"dependencies": {
"@nocobase/actions": "0.7.0-alpha.60",
"@nocobase/database": "0.7.0-alpha.60",
"@nocobase/server": "0.7.0-alpha.60",
"@nocobase/utils": "0.7.0-alpha.60",
"@nocobase/actions": "0.7.0-alpha.62",
"@nocobase/database": "0.7.0-alpha.62",
"@nocobase/server": "0.7.0-alpha.62",
"@nocobase/utils": "0.7.0-alpha.62",
"json-templates": "^4.2.0"
},
"devDependencies": {
"@nocobase/test": "0.7.0-alpha.60"
"@nocobase/test": "0.7.0-alpha.62"
},
"gitHead": "a00b45a2686695c5f4824d074ac5e1aff210793a"
}

View File

@ -1,6 +1,6 @@
{
"name": "@nocobase/preset-nocobase",
"version": "0.7.0-alpha.60",
"version": "0.7.0-alpha.62",
"license": "Apache-2.0",
"licenses": [
{
@ -11,18 +11,18 @@
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"dependencies": {
"@nocobase/plugin-acl": "0.7.0-alpha.60",
"@nocobase/plugin-china-region": "0.7.0-alpha.60",
"@nocobase/plugin-client": "0.7.0-alpha.60",
"@nocobase/plugin-collection-manager": "0.7.0-alpha.60",
"@nocobase/plugin-error-handler": "0.7.0-alpha.60",
"@nocobase/plugin-file-manager": "0.7.0-alpha.60",
"@nocobase/plugin-system-settings": "0.7.0-alpha.60",
"@nocobase/plugin-ui-routes-storage": "0.7.0-alpha.60",
"@nocobase/plugin-ui-schema-storage": "0.7.0-alpha.60",
"@nocobase/plugin-users": "0.7.0-alpha.60",
"@nocobase/plugin-workflow": "0.7.0-alpha.60",
"@nocobase/server": "0.7.0-alpha.60"
"@nocobase/plugin-acl": "0.7.0-alpha.62",
"@nocobase/plugin-china-region": "0.7.0-alpha.62",
"@nocobase/plugin-client": "0.7.0-alpha.62",
"@nocobase/plugin-collection-manager": "0.7.0-alpha.62",
"@nocobase/plugin-error-handler": "0.7.0-alpha.62",
"@nocobase/plugin-file-manager": "0.7.0-alpha.62",
"@nocobase/plugin-system-settings": "0.7.0-alpha.62",
"@nocobase/plugin-ui-routes-storage": "0.7.0-alpha.62",
"@nocobase/plugin-ui-schema-storage": "0.7.0-alpha.62",
"@nocobase/plugin-users": "0.7.0-alpha.62",
"@nocobase/plugin-workflow": "0.7.0-alpha.62",
"@nocobase/server": "0.7.0-alpha.62"
},
"repository": {
"type": "git",