https://github.com/cookpad/gem_collector
Collect gems used by applications
https://github.com/cookpad/gem_collector
rails-engine rubygems
Last synced: 6 months ago
JSON representation
Collect gems used by applications
- Host: GitHub
- URL: https://github.com/cookpad/gem_collector
- Owner: cookpad
- License: mit
- Created: 2017-03-16T09:16:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-12-27T09:58:52.000Z (over 3 years ago)
- Last Synced: 2024-04-27T01:03:44.796Z (about 1 year ago)
- Topics: rails-engine, rubygems
- Language: Ruby
- Size: 109 KB
- Stars: 27
- Watchers: 14
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# GemCollector
[](https://badge.fury.io/rb/gem_collector)
[](https://github.com/cookpad/gem_collector/actions/workflows/ci.yml)
Collect gems used by applications.
- Collect Gemfile.lock of the repository via GitHub webhook
- Show gem versions of the repository
- Show repositories using the gem
- Show "how up-to-date?" of the repository
- Create a issue to repositories using the gem
## Usage
There're two ways to add GemCollector webhook to repository.
### Add webhook from repository setting
Visit `https://github.com/:user/:repo/settings/hooks` and add `https://gem-collector.example.com/github-webhook` with `push` event.
### Add webhook from GemCollector
Visit `https://gem-collector.example.com/repositories/new` and enter repository location.
It will automatically add `ENV['WEBHOOK_URL']` with `push` event.
## Installation
### Gemfile
Add this line to your application's Gemfile:
```ruby
gem 'gem_collector'
```
### Octokit
Put config/octokit.yml like below.
```yaml
default: &default
github.com:
access_token: <%= ENV['GITHUB_ACCESS_TOKEN'] %>
webhook_secret: <%= ENV['GITHUB_WEBHOOK_SECRET'] %>
github-enterprise.example.com:
api_endpoint: https://github-enterprise.example.com/api/v3
web_endpoint: https://github-enterprise.example.com
access_token: <%= ENV['GHE_ACCESS_TOKEN'] %>
development:
<<: *default
production:
<<: *default
```
### Database
Configure database.yml. GemCollector requires PostgreSQL.
```yaml
# config/database.yml
development:
adapter: postgresql
encoding: unicode
database: gem_collector_development
production:
url: <%= ENV['DATABASE_URL'] %>
```
### ActiveJob
Configure ActiveJob adapter. We're using [Barbeque](https://github.com/cookpad/barbeque), but other adapters should work.
```ruby
# config/initializers/barbeque.rb
Rails.application.configure do
config.active_job.queue_adapter = :barbeque
end
BarbequeClient.configure do |config|
config.application = 'gem-collector'
config.default_queue = 'default'
config.endpoint =
if Rails.env.production?
ENV.fetch('BARBEQUE_ENDPOINT')
else
ENV.fetch('BARBEQUE_ENDPOINT', 'http://localhost:3003')
end
end
```
### Environment variables
- `WEBHOOK_URL` (required when `/repositories/new` is used)
- URL to be added when the repository is registered from `/repositories/new`
- Example: `https://gem-collector.example.com/github-webhook`
- `DEFAULT_GITHUB_SITE` (optional: default to `github.com`)
- Placeholder site for `/repositories/new`
- Example: `github-enterprise.example.com`
## Contributing
Contribution directions go here.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).