How to set up Continuous Integration and Continuous Deployment for a node.js Application from GitHub to Heroku
In this blog post we're gonna deploy a Node.js application from a GitHub repository to Heroku using Codeship. Before we get started, you might want to check out our Deployment to Heroku documentation article.
We've set up a simple Node.js application called codefish which contains some Jasmine specs. We'll use screenshots of this application in this blog post. If you don't have an own project to set up but you want to follow along on your computer, just fork the repository.
Together, we're gonna deploy this application to Heroku using the Codeship.
First, sign in to the Codeship with GitHub. The Codeship needs access to your GitHub repositories to be able to set them up. Let's allow access.
We're back at the Codeship. Now let's create your first project.
The first step of your project setup is to select GitHub as your repository provider.
In the list of your GitHub repositories
search for the repository you want to set up and select it. In my case I search for "codefish".
Now your repository is connected and you can set up your test commands:
Codefish is a Node.js application. So I choose "Node.js" as my framework. This prepopulates the setup commands and the test commands for you.
The Codeship suggests Node.js 0.10.18, but you can use whatever Node version you like. If you're unsure about the Node version of your project, type
node -v in the Terminal.
Just copy your Node version into the
nvm install and
nvm use statements.
If you want to run Jasmine specs, you need to install
jasmine-node globally additionally to your node modules. In this case just add
npm install -g jasmine-node after
You don't need
npm test for your Jasmine specs, so you can comment it by adding a hash key before the command. Instead, add
jasmine-node spec to the test commands to run your Jasmine specs.
Now let's finish your setup and go to the dashboard.
You can trigger a build for your application by pushing to your repository. Let's add the Codeship status image to the README file. I use markdown syntax to insert the image.
Now commit and push this change.
This triggered a new build on the Codeship.
You can access the build details by clicking the arrow on the right. Here you can follow the running build.
And a few seconds later your build succeeded! Great!
You see all the commands that were run. After a few initial preparation commands the Codeship ran the commands that you specified a few moments ago.
You can inspect the output of a single command by clicking on it. For the
codefish application, we can see that two Jasmine specs were run.
You've already pushed to your repository, watched your build log and got a green build. So you can finish the assistant at the top.
Now let's deploy your application to Heroku. Go to your project settings by clicking on the settings icon in the projects dropdown.
Then navigate to the "Deployment" section.
As we want to deploy to Heroku we click on the "Heroku" button.
Now you are asked to enter the name of your Heroku application and your API key. If you haven't already, now is the time to go to Heroku and create an application.
I named my application "codefish-app", but please choose whatever name you like
and create your app.
Back at your deployment configuration on the Codeship enter the application name.
To retrieve your Heroku API key, follow the link to your Heroku account and click "Show API key".
Copy it and insert it into your deployment configuration at the Codeship.
Now save your deployment by clicking on the green checkmark on the right.
From now on the Codeship will deploy your application to Heroku everytime you push to your GitHub repository. Let's push a change and see if it gets deployed. Change something in your application first,
then commit and push the change.
And immediately another build will start running on the Codeship. Let's go back to your project overview.
After the commands we already know from your first build, your application also gets deployed to Heroku now.
And about 2 minutes later your application is online.
When you open the URL of your Heroku app now, your deployed application appears. You can find mine on codefish-app.herokuapp.com.
If you need help with setting up your own application, please use the support link in the top-right corner or please tweet us @codeship!