Skip to main content

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
  • 对于从除了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 codespace 中使用。推荐在 dev containers 中开发 AutoGen。