EnvPullRequest

Get PULL_REQUEST_ID from environment variables.

Usage

require 'env_pull_request'

env_pull = EnvPullRequest.new
env_pull.pull_request? #=> true
env_pull.pull_request_id #=> 800

User defined block

require 'env_pull_request'
require 'natural_number_string'

env_pull =
  EnvPullRequest.new do
    if NaturalNumberString.positive_integer_string? ENV['PULL_REQUEST_ID']
      ENV['PULL_REQUEST_ID'].to_i
    end
  end
env_pull.pull_request? #=> true
env_pull.pull_request_id #=> 800

API

EnvPullRequest.new -> Base

EnvPullRequest.new(&block) -> Base

block

optional

Type: block

User defined block for getting pull request id.

Base#pull_request_id -> Integer | nil

Return pull request id or nil.

Base#pull_request? -> boolean

Return true if this is pull request.

And more details.

Supported services / applications

• Travis-ci
  • ENV['TRAVIS_PULL_REQUEST']
  • Environment Variables - Travis CI
• CircleCI
  • ENV['CIRCLE_PR_NUMBER']
  • Environment variables - CircleCI
• Bitrise
  • ENV['BITRISE_PULL_REQUEST']
  • Environment variables - Bitrise
• Jenkins GitHub pull request builder plugin
  • ENV['ghprbPullId']
  • GitHub pull request builder plugin - Jenkins - Jenkins Wiki

Related

• env-branch

Changelog

changelog.md.

Installation

Add this line to your application's Gemfile:

gem 'env_pull_request'

And then execute:

$ bundle

Or install it yourself as:

$ gem install env_pull_request

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_pull_request. 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.

Thanks

• rosylilly
• skorfmann

License

© sanemat

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