https://github.com/peek/peek-git
Take a peek into the Git info of your Rails application.
https://github.com/peek/peek-git
git peek ruby
Last synced: 3 months ago
JSON representation
Take a peek into the Git info of your Rails application.
- Host: GitHub
- URL: https://github.com/peek/peek-git
- Owner: peek
- License: mit
- Created: 2013-03-09T22:01:04.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T17:15:25.000Z (almost 7 years ago)
- Last Synced: 2024-08-08T15:27:08.009Z (about 1 year ago)
- Topics: git, peek, ruby
- Language: Ruby
- Homepage:
- Size: 195 KB
- Stars: 17
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Peek::Git
Take a peek into the Git info of your Rails application.
Things this peek view provides:
- View the current branch name
- Compare the diff of the current revision on your GitHub repo
## Installation
Add this line to your application's Gemfile:
gem 'peek-git'
And then execute:
$ bundle
Or install it yourself as:
$ gem install peek-git
## Usage
Add the following to your `config/initializers/peek.rb`:
```ruby
Peek.into Peek::Views::Git
```
You will need to set the GitHub project's name with owner if you plan on
comparing the current ref against your default branch on GitHub.
```ruby
# nwo - name with owner - owner/name
Peek.into Peek::Views::Git, :nwo => 'dewski/json_builder'
```
You can also manually set each of the following optional options:
- SHA
- Default Branch (master by default)
- Branch Name
- Domain Name (github.com by default)
- Protocol (https by default)
```ruby
Peek.into Peek::Views::Git, \
:sha => '740f6b7b11b8717efaf51ddb98ce23394544f7e0',
:default_branch => 'rails4.0',
:branch_name => 'integration',
:domain => 'github.com',
:protocol => 'https'
```
## Using Peek::Git on Heroku
Unfortunately Heroku [removes](https://devcenter.heroku.com/articles/slug-compiler#compilation)
the .git directory during slug compilation which doesn't make it possible to
view the current deployed SHA or branch.
The one workaround is to set the GIT_SHA and GIT_BRANCH ENV variables within
your deploy process.
## 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