{"id":8317,"date":"2020-06-27T18:34:38","date_gmt":"2020-06-27T18:34:38","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=8317"},"modified":"2020-06-27T18:34:38","modified_gmt":"2020-06-27T18:34:38","slug":"getting-started-with-circleci-and-github","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/getting-started-with-circleci-and-github\/","title":{"rendered":"Getting started with Circleci and GitHub"},"content":{"rendered":"

In my previous post I talked about using CI\/CD along with GitHub and in that post we concentrated on Appveyor. Let’s now look at one of the alternatives, Circleci<\/a>.<\/p>\n

As you’d expect, you need to create an account and I used GitHub authentication as I wanted this CI\/CD application working with my GitHub projects. It’s probably not a requirement but certainly everything integrated nicely (I’ve not yet seen if that differs with alternative repositories hosts).<\/p>\n

Once you’ve created your account you’ll need to install the Circleci application within GitHub – I actually don’t recall the process but I suspect there’s an “Install Application” button or the likes.<\/p>\n

Let\u2019s get started<\/strong><\/p>\n

Due to the GitHub integration you’ll see a list of your projects. Simply press the Set Up Project<\/em> button. That’s pretty much all there is to it to get started, but we’re probably going to want to customise the process.<\/p>\n

In your project’s repository add the file config.yml into the .circleci folder, as below<\/p>\n

\r\n.circleci\/config.yml\r\n<\/pre>\n
This allows us to write the configuration for our Circleci build pipeline using a DSL. Here’s one for an F# project I have in Circleci<\/p>\n
\r\n version: 2.1\r\n\r\n orbs:\r\n  win: circleci\/windows@2.2.0\r\n\r\n jobs:\r\n   build:\r\n     executor: win\/default     \r\n    \r\n     steps:\r\n       - checkout\r\n       - run: dotnet build\r\n       - run: dotnet test Image.Processing.Tests\r\n<\/pre>\n
In this case we’re using the 2.1 (see CircleCI 2.1 Configuration Reference Guide<\/a>. <\/p>\n
The first thing we do (after setting the version of the DSL) is to map to an orb definition. In this case we’re using a predefined orb, we can actually create our own orbs if needed (but we’re not going there at the moment, or maybe ever, we’ll have to wait and see).<\/p>\n
Note: An orb is a shareable package of configuration, see Explore Orbs<\/a> for a whole bunch of different orbs.<\/em>.<\/p>\n
Now we supply the jobs<\/em>. In this case a build<\/em> job using win\/default<\/em>, basically a Windows image. <\/p>\n
Next we set up the build steps. These are self-explanatory, as you’d expect, we need to checkout<\/em> our code, build the code and then run our tests. There’s a checkout<\/em> step, the rest can be thought of as simply commands to run.<\/p>\n
We’re now going to want to add a badge to the README.md in our project to allow us and others to see the status of our build.<\/p>\n
Unlike Appveryor (unless I’m missing something, in which case I’ll update this post later) there’s no copy & paste option for the badge link, instead have a look as Adding Status Badges<\/a>, here’s the template<\/p>\n
\r\n[![<ORG_NAME>](https:\/\/circleci.com\/<VCS>\/<ORG_NAME>\/<PROJECT_NAME>.svg?style=svg)](<LINK>)\r\n<\/pre>\n
So for my F# Image.Processing project this looks like the following<\/p>\n
\r\n[![putridparrot](https:\/\/circleci.com\/gh\/putridparrot\/Image.Processing.svg?style=svg)](https:\/\/circleci.com\/gh\/circleci\/circleci-docs)\r\n<\/pre>\n
At this time, I’m not sure how to link to the specific build (or whether this is possible), I ‘ll add to this post in the future if I find it’s possible.<\/p>\n
Note: If you prefer, change style=svg<\/em> to style=shield<\/em> for a different looking status image.<\/em><\/p>\n
That should get you started.<\/p>\n","protected":false},"excerpt":{"rendered":"
In my previous post I talked about using CI\/CD along with GitHub and in that post we concentrated on Appveyor. Let’s now look at one of the alternatives, Circleci. As you’d expect, you need to create an account and I used GitHub authentication as I wanted this CI\/CD application working with my GitHub projects. It’s […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[301,302,297],"tags":[],"class_list":["post-8317","post","type-post","status-publish","format-standard","hentry","category-ci-cd","category-circleci","category-github"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/8317","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=8317"}],"version-history":[{"count":4,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/8317\/revisions"}],"predecessor-version":[{"id":8321,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/8317\/revisions\/8321"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=8317"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=8317"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=8317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}