1. Home
  2. Product Guides
  3. Deployment Tracking
  4. Legacy
  5. Rake

Rake

note: This guide is now considered legacy and use of the new API is recommended. A high level guide to migrate to the new API can be found here.

Generate an External Auth Token for your build server to use from your Raygun User Settings page

Install the rake-raygun-deployment gem

gem install rake-raygun-deployment

Or if you are using Bundler

echo "gem 'rake-raygun-deployment'" >> Gemfile
bundle install

Add the following to your Rakefile

require 'rake-raygun-deployment'

Rake::RaygunDeployment.new(:raygun_deployment) do
    releasePath "RELEASE"
    authToken "YOUR_EXTERNAL_AUTH_TOKEN"
    apiKey "YOUR_APPLICATIONS_API_KEY"
end

When you are ready to deploy, create a release file in RELEASE (or whatever release path you have chosen) with the following format:

version: 6.0.0.0
ownerName: Jamie Penney
emailAddress: jamie@example.com
notes: |
    # Testing out the rake plugin

    * More markdown formatting

    ### Jamie

Run rake raygun_deployment to register your deployment with Raygun!

On this page: