env_branch

EnvBranch

Get BRANCH_NAME from environment variables.

Usage

require 'env_branch'

env_branch = EnvBranch.new
env_branch.branch? #=> true
env_branch.branch_name #=> 'your-branch-name'

User defined block

require 'env_branch'

env_branch =
  EnvBranch.new do
    if ENV['USER_DEFINED_BRANCH'] &&
       !ENV['USER_DEFINED_BRANCH'].empty?
      ENV['USER_DEFINED_BRANCH']
    end
  end

env_branch.branch? #=> true
env_branch.branch_name #=> 'your-branch-name'

API

EnvBranch.new -> Base

EnvBranch.new(&block) -> Base

block

optional

Type: block

User defined block for getting branch name.

Base#branch_name -> String | nil

Return branch name or nil.

Base#branch? -> boolean

Return true if this has branch name.

And more details.

Supported services / applications

• Travis-ci
  • ENV['TRAVIS_BRANCH']
  • Environment Variables - Travis CI
• CircleCI
  • ENV['CIRCLE_BRANCH']
  • Environment variables - CircleCI
• Bitrise
  • ENV['BITRISE_GIT_BRANCH']
  • Environment variables - Bitrise
• GitHub pull request builder plugin (for Jenkins)
  • ENV['ghprbSourceBranch']
  • Environment Variables
• Git Plugin (for Jenkins)
  • ENV['GIT_BRANCH']
  • Environment variables

Related

• env_pull_request

Changelog

changelog.md.

Installation

Add this line to your application's Gemfile:

gem 'env_branch'

And then execute:

$ bundle

Or install it yourself as:

$ gem install env_branch

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/packsaddle/ruby-env_branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

© sanemat

The gem is available as open source under the terms of the MIT License.