open-im-server/tools/README.md

Notes about go workspace

As openim is using go1.18's workspace feature, 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:

# 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 ../..