跳到主要内容

开发环境中的Docker

对于为AutoGen项目做出贡献的开发者,我们提供了一个专门的Docker环境。此设置旨在简化开发流程,确保所有贡献者在一个一致且配备良好的环境中工作。

Autogen开发者镜像 (autogen_dev_img)

  • 目的: autogen_dev_img 专为 AutoGen 项目的贡献者设计。它包含了一系列工具和配置,帮助开发和测试新功能或修复。
  • 使用: 该镜像推荐给希望为AutoGen贡献代码或文档的开发者使用。
  • 项目分叉: 建议将AutoGen GitHub项目分叉到您自己的仓库中。这使您可以在单独的环境中进行更改,而不会影响主项目。
  • 更新Dockerfile: 根据你的开发需求修改 dev 文件夹中的 Dockerfile 副本。
  • 提交拉取请求:当您的更改准备就绪后,从您的分支向上游的AutoGen GitHub项目提交拉取请求以供审查和集成。有关更多贡献细节,请参见AutoGen贡献页面。

构建开发者Docker镜像

  • 要构建开发者 Docker 镜像(autogen_dev_img),请使用以下命令:

    docker build -f .devcontainer/dev/Dockerfile -t autogen_dev_img https://github.com/microsoft/autogen.git#main
  • 为了构建从特定的Dockerfile在非main/master分支中构建开发人员镜像

    # 克隆你想要工作的分支
    git clone --branch {branch-name} https://github.com/microsoft/autogen.git

    # 切换到新目录
    cd autogen

    # 构建你的Docker镜像
    docker build -f .devcontainer/dev/Dockerfile -t autogen_dev-srv_img .

使用开发者Docker镜像

一旦你构建了autogen_dev_img,你可以使用标准的Docker命令来运行它。这将使你进入容器化的开发环境中,你可以在其中运行测试、开发代码,并在提交你的贡献之前确保一切如预期般正常运行。

docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_dev_img bash
  • 请注意,pwd 是当前工作目录的缩写。因此,pwd 之后的任何路径都是相对于它的。如果你想要一个更详细的方法,你可以移除 "pwd/autogen-newcode" 并用你目录的完整路径替换它
docker run -it -p 8081:3000 -v /home/AutoGenDeveloper/autogen-newcode:newstuff/ autogen_dev_img bash

在远程容器中开发

如果你使用vscode,你可以在容器中打开autogen文件夹。 我们在devcontainer中提供了配置。它们也可以在GitHub代码空间中使用。建议在开发容器中开发AutoGen。