Class: CreateGithubRelease::Assertions::OnDefaultBranch

Inherits:

CreateGithubRelease::AssertionBase

• Object
• CreateGithubRelease::AssertionBase
• CreateGithubRelease::Assertions::OnDefaultBranch

Defined in:

lib/create_github_release/assertions/on_default_branch.rb

Overview

Assert that the default branch is checked out

Checks both the local repository and the remote repository.

Instance Attribute Summary

Attributes inherited from CreateGithubRelease::AssertionBase

#project

Instance Method Summary

• #assert

  Assert that the default branch is checked out.

Methods inherited from CreateGithubRelease::AssertionBase

#backtick_debug?, #error, #initialize, #print, #puts

Methods included from BacktickDebug

#`

Constructor Details

This class inherits a constructor from CreateGithubRelease::AssertionBase

Instance Method Details

#assert

This method returns an undefined value.

Assert that the default branch is checked out

Examples:

require 'create_github_release'

options = CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'major' }
project = CreateGithubRelease::Project.new(options)
assertion = CreateGithubRelease::Assertions::OnDefaultBranch.new(project)
begin
  assertion.assert
  puts 'Assertion passed'
rescue SystemExit
  puts 'Assertion failed'
end

Raises:

• (SystemExit) —

  if the assertion fails

# File 'lib/create_github_release/assertions/on_default_branch.rb', line 34

def assert
  print 'Checking that you are on the default branch...'
  current_branch = `git branch --show-current`.chomp
  if current_branch == project.default_branch
    puts 'OK'
  else
    error "You are not on the default branch '#{project.default_branch}'"
  end
end