将配置项添加到分叉

本教程将帮助您将Coala存储库中用于测试代码的CI工具添加到您的分叉存储库。我们建议您在进行PR之前添加所有配置项并在您自己的存储库中测试所有内容。

在我们开始添加配置项之前,重要的是您拥有GitHub帐户并知道如何派生存储库。如果你没有,你应该看看我们的 Git Tutorial .

特拉维斯CI

Travis用于确认工具安装和构建是否正确。它还运行测试并确认所有测试用例都通过并具有100%的覆盖率。以下是Coala和Coala-Bear存储库中使用的Travis CI检查的示例:https://travis-ci.com/coala/coala/和https://travis-ci.com/coala/coala-bears/.要在Travis中运行相同的CI检查,您需要配置您的派生存储库,并按照下面提到的步骤进行配置。

  1. travis-ci.com 并创建一个帐户。你只需使用你的GitHub账户就可以了。

  2. 在左上角,您将在“我的存储库”旁边看到一个“+”图标。点击它,它将带您进入您的Travis-ci个人资料。

  3. 单击右上角的“同步帐户”按钮,将您的帐户与GitHub同步。

  4. 在列表中找到forked Coala存储库,并为其启用构建。

  5. Travis CI需要包含设置和构建说明的.travis.yml文件,例如 coala's .travis.yml 。您从Coala派生的存储库将已经拥有该文件。

  6. 查看travis-ci.com/<username>/<pository>/builds上的构建。

AppVeyor配置项

为了了解Coala在Microsoft Windows中的行为,我们使用AppVeyor,它在Microsoft Windows框中运行测试和构建命令。以下是在AppVeyor中构建CI的示例:https://ci.appveyor.com/project/coala/coala/和https://ci.appveyor.com/project/coala/coala-bears/.现在,要将相同的Appveyor配置项添加到您的派生存储库,请按照以下说明操作。

  1. ci.appveyor.com 并使用您的GitHub帐户登录。

  2. 单击“新建项目”,从您的用户名下面列出的存储库中找到分叉存储库。

  3. 在右侧,您将看到一个“添加”按钮,单击它,它会将其添加到您的项目中。

  4. AppVeyor配置项需要appvyor.yml文件,该文件应包含Windows的设置和说明,例如 coala's appveyor.yml 。您的分叉存储库已经具有该文件。

  5. 如果它的名称不同或不在根目录中,则必须在ci.appveyor.com/project/<username>/<repository>/settings.中的设置中对其进行配置对于Coala的存储库,appveyor.yml文件位于.misc目录中。因此,您必须进入设置,然后在“Custom Configuration.yml file name”(自定义配置.yml文件名)下输入 .misc/appveyor.yml 。对于Coala-Bear的存储库,appveyor.yml文件位于.ci目录中。所以你必须进入 .ci/appveyor.yml 。如果您派生了不同的存储库,请为其输入正确的.yml文件路径。

  6. 在Coala中,appveyor.yml将设置设置为仅从主分支构建,但是在您的fork中,您可能还希望它构建其他分支。您可以通过在设置中配置“要构建的分支”来做到这一点,因此不需要为此更改文件。

  7. 从现在开始,Appveyor将为您推送的每个提交运行构建,您可以在ci.appveyor.com/project/<username>/<repository>.上查看您也可以通过单击“New Build”开始自己的构建

编解码器

我们需要100%的测试覆盖率,并且要测试我们使用的 codecov.io 它从所有其他配置项中获取数据以确认其覆盖范围。下面是来自Coala和Coala-Bear存储库的两个示例报告:https://codecov.io/gh/coala/coala/和https://codecov.io/gh/coala/coala-bears/.一旦您按照这里的说明操作,您的分叉存储库就会有完全相同的报告。

  1. codecov.io 并使用您的GitHub帐户注册。

  2. 单击您的用户名,您将进入一个页面,其中列出了使用编解码器的存储库。

  3. 单击“添加新存储库”,它将带您进入一个列出所有存储库的页面。选择要为其启用编解码器的派生存储库。

  4. 与其他配置项一样,这也有一个配置文件.codecov.yml文件,您的派生存储库将已有该文件。e.g coala's .codecov.yml CI将测试报告上传到编解码器,编解码器然后创建总体覆盖报告。

  5. 您可以在codecov.io/gh/<用户名>/<存储库>上查看报告

备注

请避免在您的分支上启用CircleCI,因为它们使用共享构建池。如果您需要访问私有构建,则可以改用TravisCI。

圆CI

Circle CI也用于与Travis相同的目的,用于检查所有内容的安装和构建是否正确,以及运行测试。以下是圈CI中的检查示例:https://circleci.com/gh/coala/coala/和https://circleci.com/gh/coala/coala-bears/.要将这些配置项构建添加到您的分叉存储库,请按照此处的说明操作。

  1. circleci.com 并使用您的GitHub帐户注册。

  2. 注册后,它会把你带到仪表板,上面列出了已经使用了Circle和没有使用Circle的项目。默认情况下,它会选择所有的存储库,但是如果你愿意,你可以取消选择它们,只选择分叉的存储库。

  3. 然后点击“Follow and Build”按钮。

  4. 在项目设置中,转到构建设置下的调整并行度,并通过单击带有“2x”的框来启用第二个容器。

  5. 它使用Circle.yml文件运行构建。e.g coala's circle.yml 。您从Coala派生的存储库将已经拥有该文件。

  6. 然后,您可以在Circuleci.com/gh/<用户名>/<存储库>上查看构建。

  7. 在项目设置中,转到“生成设置”下的“生成环境”。默认情况下,您将看到用于构建的操作系统是可信的,但是我们建议使用Precision,因为它速度更快。