mirror of
https://github.com/openimsdk/open-im-server.git
synced 2025-04-05 20:11:14 +08:00
b26a979378
* feat: add scripts format Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add go work Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# Notes about go workspace
|
|
|
|
As openim is using go1.18's [workspace feature](https://go.dev/doc/tutorial/workspaces), once you add a new module, you need to run `go work use -r .` at root directory to update the workspace synced.
|
|
|
|
### Create a new extensions
|
|
|
|
1. Create your tools_name directory in pkg `/tools` first and cd into it.
|
|
2. Init the project.
|
|
3. Then `go work use -r .` at current directory to update the workspace.
|
|
4. Create your tools
|
|
|
|
You can execute the following commands to do things above:
|
|
|
|
```bash
|
|
# 4dd91a700d3f:/openim# tree
|
|
# .
|
|
# ├── LICENSE
|
|
# ├── README.md
|
|
# ├── openim-chat
|
|
# │ ├── bin
|
|
# │ ├── config
|
|
# │ ├── logs
|
|
# │ └── scripts
|
|
# ├── openim-server
|
|
# │ ├── bin
|
|
# │ ├── config
|
|
# │ ├── logs
|
|
# │ └── scripts
|
|
# ├── openkf
|
|
# │ ├── bin
|
|
# │ ├── config
|
|
# │ ├── logs
|
|
# │ └── scripts
|
|
# cd tools_code_dir
|
|
# edit the CRD_NAME and CRD_GROUP to your own
|
|
export OPENIM_TOOLS_NAME=<Changeme>
|
|
|
|
# copy and paste to create a new CRD and Controller
|
|
mkdir tools/${OPENIM_TOOLS_NAME}
|
|
cd tools/${OPENIM_TOOLS_NAME}
|
|
go mod init github.com/OpenIMSDK/Open-IM-Server/tools/${OPENIM_TOOLS_NAME}
|
|
go mod tidy
|
|
go work use -r .
|
|
cd ../..
|
|
``` |