yalegria / devops-git-actions

0 stars 0 forks source link

List the steps to get started with CircleCI #28

Open yalegria opened 2 years ago

Voxelghiest commented 2 years ago

Setting yourself up with CircleCI is fairly straightforward. Here's what you need to do.

  1. Go to https://circleci.com/signup and select the option to sign in with GitHub, which will make the integration process easy. Sign into your GitHub account and follow the prompts until you reach the following setup page: CircleCI 1
  2. This is where you'll be able to link CircleCI to a repo of your choice, although you can also easily do so later. If you have a repo to link in now, fill out the appropriate fields to locate it (I don't know how it works with an organization like RutgersGRID; you might need some sort of permission), and then go to step 5.
  3. For this example, I clicked "Skip Setup" at the bottom and continued finishing the signup process until I was led to the main application webpage, which should look something like this: CircleCI 2
  4. The Dashboard is your main page for monitoring various projects. To add a new project and configure it for CircleCI, simply select whichever repo you want to set up.
  5. Once you have selected a repo, it will ask how you wish to go about setting up the pipeline. Choose "Fast" so that you get a chance to examine how a basic CircleCI pipeline works. A list of template pipelines will be presented; for now, choose "Hello World". You'll be led to this page: CircleCI 3
  6. Here, you can take a look at the structure of a CIrcleCI pipeline. The Hello World template is configured to run when you commit to the branch, but do keep in mind that the pipeline is initially committed to a separate branch in your project called "circleci-project-setup". You will have to merge that branch into your main branch to see the pipeline there.
  7. Once you are ready, select the option to commit the configuration and it will create the new branch with the CircleCI config. You should automatically be brought to a page where you can look through the results of the pipeline and see the console output.

After merging the new branch back into the main one, your project is now set up to utilize CircleCI. When you need to examine the pipeline configuration or any workflow output, you'll return to the application webpage. More information on the CIrcleCI pipeline and its syntax can be found at https://circleci.com/docs/2.0/config-intro/.