https://github.com/railsware/capistrano-ci

https://github.com/railsware/capistrano-ci

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/railsware/capistrano-ci
• Owner: railsware
• License: mit
• Created: 2013-10-05T13:20:21.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-07-31T07:11:46.000Z (over 11 years ago)
• Last Synced: 2025-04-22T23:12:55.489Z (9 months ago)
• Language: Ruby
• Size: 322 KB
• Stars: 16
• Watchers: 54
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Capistrano::Ci

[![Build Status](https://travis-ci.org/railsware/capistrano-ci.svg?branch=master)](https://travis-ci.org/railsware/capistrano-ci)

## Introduction

capistrano-ci is extension for capistrano that allows you to check status of your repository before deployment. Currently it supports:

  * Travis CI: Open Source and Pro versions ([https://travis-ci.org](https://travis-ci.org) or [https://travis-ci.com](https://travis-ci.com))

  * CircleCi: [https://circleci.com](https://circleci.com)

  * Semaphore: [https://semaphoreapp.com](https://semaphoreapp.com)

## Installation

Add this line to your application's Gemfile:

    gem 'capistrano-ci'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install capistrano-ci

Add to your Capfile:

    require 'capistrano/ci/recipes'

## Configuration

Variables list:

  * :ci_client (required) - supports `travis`, `travis_pro`, `circle`, or `semaphore`

  * :ci_repository (required) - organization or user name and repository name on github

  * :ci_access_token(required for `travis_pro`, `circle`, or `semaphore`) - access token specific to the service

### Open Source Projects

Setup ci_client and ci_repository variables in your deployment script:

     set :ci_client, "travis"

     set :ci_repository, "organisation-or-user/repository-name"

### Pro Account of Travis-CI:

Additional to ci_client and ci_repository setup ci_access_token:

     set :ci_client, "travis_pro"

     set :ci_repository, "organisation-or-user/repository-name"

     set :ci_access_token, "your-pro-access-token"

Read explaination [how to obtain Travis-CI access token](http://railsware.com/blog/2013/09/10/capistrano-recipe-for-checking-travis-ci-build-status/). To have more information about Travis-CI access token follow [this blog post](http://about.travis-ci.org/blog/2013-01-28-token-token-token).

### CircleCi:

Setup ci_client, ci_repository and ci_access_token in your deployment script:

     set :ci_client, "circle"

     set :ci_repository, "organisation-or-user/repository-name"

     set :ci_access_token, "your-circle-access-token"

### Semaphore:

Setup ci_client, ci_repository and ci_access_token in your deployment script:

    set :ci_client, "semaphore"

    set :ci_repository, "organisation-or-user/repository-name"

    set :ci_access_token, "your-semaphore-access-token"

### Enable ci:verify task:

     before 'deploy', 'ci:verify'

     # or in case of using capistrano-patch:

     before 'patch:create', 'ci:verify'

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## Copyright

Copyright (c) 2013 Railsware LLC. See LICENSE.txt for

further details.