从CircleCI CLI开始
概述
对于那些喜欢在终端上花费大部分开发时间的人,可以考虑安装CircleCI CLI与Circleci的项目互动。本文档提供了跨初始化和使用主要来自终端内的Circleci项目的逐步指南。请注意,我们的服务器提供仅支持CLI的旧版版本。您可以找到有关如何安装的更多信息:https://www.drag240sx.com/docs/2.0/local-cli/#using-the-cli-on-circleci-server。
先决条件
- 您使用的是unix机器(Mac或Linux): CircleCI CLI工具是可在Windows上安装,但目前是beta版,功能不像unix安装那样全面。
- 您对CI / CD的基本知识以及Circleci产品的特征和概念。
- 你有一个github帐户
- 你有一个circleci帐户。
- 您的终端打开并准备好了。
- 可选:GitHub的安装
枢纽
命令行工具(允许我们与来自命令行而不是Web UI的GitHub接口)。学习如何安装集线器。
如果这些先决条件中的一些声音不熟悉,或者您是Circleci平台的新手,您可能需要考虑阅读我们的入门指导或阅读我们的概念文档在继续之前。
脚步
初始化一个git回购
让我们从最基础的开始:创建一个项目并初始化一个git存储库。有关步骤列表,请参阅下面的代码块。
光盘〜导航到您的主目录。MKDIR.foo_ci#在名为“foo_ci”的文件夹中创建项目光盘foo_ci#将目录更改为新的foo_ci文件夹。git init.#创建git存储库触摸readme.md.#创建一个文件以放入存储库回声“Hello World !”>>readme.md.git补充道。#阶段每个文件进行提交git提交-M.“初步提交”#创建您的第一个提交。
将Git Repo连接到VCS
太棒了!我们设置了一个git存储库,其中一个文件显示“Hello World!”我们需要将本地git存储库连接到一个版本控制系统——不管是GitHub还是BitBucket。现在就开始吧。
如果已安装并设置集线器CLI,则可以简单运行:
集线器创造
然后遵循关于登录/授权集线器CLI的任何提示。
如果您没有使用集线器,请将返回Github,登录和创建新的respository。按照指示提交和推送到远程服务器。这些说明通常是这样的:
git远程添加源git@github.com:/foo_ci.git push——set-upstream起源的主人
现在,您有了一个连接到VCS的git回购。你的VCS上的遥控器(“origin”)现在匹配你的本地工作。
下载并设置circleci cli
接下来,我们将安装Circleci CLI并尝试其一些功能。要在UNIX计算机上安装CLI,请在终端中运行以下命令:
卷曲-fls.https://circle.ci/cli |抨击
CLI有多种安装方法,您可以阅读更多关于它们的信息这里如果您需要使用替代方法。
现在安装后运行设置步骤:
Circleci设置
你会被要求获得你的API令牌。去吧帐号设定页面,点击创建一个新令牌
。为您的令牌命名并复制生成的令牌字符串并将其保留安全!
返回到CLI并粘贴API令牌以完成设置。
设置并验证我们的第一个配置
现在在我们的项目目录中创建一个配置文件。
光盘~ / foo_ci#确保您仍然在foo_ci文件夹中MKDIR..circleci.创建一个名为".circleci"的目录光盘.circleci.#将目录更改为新目录触摸config.yml#创建名为“config.yml”的yaml文件
上面的命令创建.circleci.
文件夹我们将存储我们的配置文件。
打开新创建的config.yml
文件并将以下内容粘贴到其中。
版:2.0职位:建立:码头工人:-图片:circleci / ruby: 2.4.2-jessie-node验证:用户名:mydockerhub-user.密码:$ dockerhub_password.#上下文/项目UI env-var引用脚步:-结帐-运行:回声“你好世界”
现在让我们验证您的配置,以确保它是可用的。在项目的根目录中,运行以下命令:
circleci config验证
注意:如果在任何时候您想要了解有关您正在使用的命令的更多信息,您可以附加——帮助
要在终端接收该命令的附加信息:
circleci config验证——帮助
在推送到VCS之前测试作业
CircleCI CLI允许您从命令行本地测试作业,而不必将作业推给VCS。如果您的配置中的某个作业被证明有问题,这是在本地尝试和调试它的好方法,而不是在平台上使用积分或分钟。
尝试在本地运行“构建”作业:
circleci本地执行
在本例中,这将拉下您指定的docker映像Circleci / Ruby :: 2.4.2-Jessie-node
并运行这份工作。这可能需要一点时间,具体取决于您使用的Docker图像的大小。
您应该在终端中看到相当多的文本。最后几行输出应该看起来类似:
==== >>检查代码# !/bin/bash eo pipefailMKDIR.-P./home/circleci/project&&CP-R./ tmp / _circleci_local_build_repo /。/home/circleci/project==== >>回声“你好,世界”# !/bin/bash eo pipefail回声“你好,世界”你好世界的成功!
将你的回购连接到循环
我们需要将终端留在此步骤。前往“添加项目页面”。现在应该将项目设置为在每次提交代码时都运行CI。
在项目列表中找到您的项目(“foo_ci”,或您在github上命名的任何东西),然后单击“设置项目”。接下来,返回您的终端并将您的最新更改推到Github(添加我们的添加)config.yml
文件。)
git补充道。git提交-M.“添加配置。yml文件”git推
在浏览器中返回Circleci,您现在可以单击“开始构建”以运行您的构建。
下一步
本文提供了开始使用CircleCI CLI工具的一个小概述。有几个更复杂的功能,CircleCI CLI提供:
- 创建,查看,验证和发布绿色原子
- 查询CircleciGraphQL API
- 打包和处理复杂的配置文件。
考虑阅读我们文件覆盖有关更多细节,请参阅CLI。