Commit bc14ed0b15d446150901f2bf445a469ac8133144
1 parent
9685479a
Exists in
master
and in
1 other branch
Ref #782 add docs for installing tracker plugins
Showing
2 changed files
with
23 additions
and
64 deletions
Show diff stats
Gemfile
| @@ -107,3 +107,6 @@ gem 'uglifier' | @@ -107,3 +107,6 @@ gem 'uglifier' | ||
| 107 | gem 'jquery-rails', '~> 2.1.4' | 107 | gem 'jquery-rails', '~> 2.1.4' |
| 108 | gem 'pjax_rails' | 108 | gem 'pjax_rails' |
| 109 | gem 'underscore-rails' | 109 | gem 'underscore-rails' |
| 110 | + | ||
| 111 | +ENV['USER_GEMFILE'] ||= './UserGemfile' | ||
| 112 | +eval_gemfile ENV['USER_GEMFILE'] if File.exist?(ENV['USER_GEMFILE']) |
README.md
| @@ -336,77 +336,33 @@ ErrorReport.fingerprint_strategy = Fingerprint::MD5 | @@ -336,77 +336,33 @@ ErrorReport.fingerprint_strategy = Fingerprint::MD5 | ||
| 336 | 336 | ||
| 337 | The easiest way to add custom fingerprint methods is to simply subclass `Fingerprint` | 337 | The easiest way to add custom fingerprint methods is to simply subclass `Fingerprint` |
| 338 | 338 | ||
| 339 | -Issue Trackers | ||
| 340 | --------------- | ||
| 341 | - | ||
| 342 | -**Lighthouseapp Integration** | ||
| 343 | - | ||
| 344 | -* Account is the name of your subdomain, i.e. **litcafe** for project at http://litcafe.lighthouseapp.com/projects/73466-face/overview | ||
| 345 | -* Errbit uses token-based authentication. Get your API Token or visit [http://help.lighthouseapp.com/kb/api/how-do-i-get-an-api-token](http://help.lighthouseapp.com/kb/api/how-do-i-get-an-api-token) to learn how to get it. | ||
| 346 | -* Project id is number identifier of your project, i.e. **73466** for project at http://litcafe.lighthouseapp.com/projects/73466-face/overview | ||
| 347 | - | ||
| 348 | -**Redmine Integration** | ||
| 349 | - | ||
| 350 | -* Account is the host of your redmine installation, i.e. **http://redmine.org** | ||
| 351 | -* Errbit uses token-based authentication. Get your API Key or visit [http://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication](http://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication) to learn how to get it. | ||
| 352 | -* Project id is an identifier of your project, i.e. **chilliproject** for project at http://www.redmine.org/projects/chilliproject | 339 | +Plugins and Integrations |
| 340 | +------------------------ | ||
| 341 | +You can extend Errbit by adding Ruby gems and plugins which are generally also | ||
| 342 | +gems. It's nice to keep track of which gems are core Errbit dependencies and | ||
| 343 | +which gems are your own dependencies. If you want to add gems to your own | ||
| 344 | +Errbit, place them in a new file called `UserGemfile`. If you want to use a | ||
| 345 | +file with a different name, you can pass the name of that file in an | ||
| 346 | +environment variable named `USER_GEMFILE`. For example, if you wanted to use | ||
| 347 | +errbit_jira_plugin, you could: | ||
| 353 | 348 | ||
| 354 | -**Pivotal Tracker Integration** | ||
| 355 | - | ||
| 356 | -* Errbit uses token-based authentication. Get your API Key or visit [http://www.pivotaltracker.com/help/api](http://www.pivotaltracker.com/help/api) to learn how to get it. | ||
| 357 | -* Project id is an identifier of your project, i.e. **24324** for project at http://www.pivotaltracker.com/projects/24324 | ||
| 358 | - | ||
| 359 | -**Thoughtworks Mingle Integration** | ||
| 360 | - | ||
| 361 | -* Account is the host of your mingle installation. i.e. **https://mingle.example.com** *note*: You should use SSL if possible. | ||
| 362 | -* Errbit uses 'sign-in name' & password authentication. You may want to set up an **errbit** user with limited rights. | ||
| 363 | -* Project id is the identifier of your project, i.e. **awesomeapp** for project at https://mingle.example.com/projects/awesomeapp | ||
| 364 | -* Card properties are comma separated key value pairs. You must specify a 'card_type', but anything else is optional, e.g.: | ||
| 365 | - | ||
| 366 | -``` | ||
| 367 | -card_type = Defect, status = Open, priority = Essential | 349 | +```bash |
| 350 | +echo "gem 'errbit_jira_plugin'" > UserGemfile | ||
| 351 | +bundle install | ||
| 368 | ``` | 352 | ``` |
| 369 | 353 | ||
| 370 | -**GitHub Issues Integration** | ||
| 371 | - | ||
| 372 | -* For 'Account/Repository', the account will either be a username or organization. i.e. **errbit/errbit** | ||
| 373 | -* You will also need to provide your username and password for your GitHub account. | ||
| 374 | - * (We'd really appreciate it if you wanted to help us implement OAuth instead!) | ||
| 375 | - | ||
| 376 | -**Bitbucket Issues Integration** | ||
| 377 | - | ||
| 378 | -* For 'BITBUCKET REPO' field, the account will either be a username or organization. i.e. **errbit/errbit** | ||
| 379 | -* You will also need to provide your username and password for your Bitbucket account. | ||
| 380 | - | ||
| 381 | -**Gitlab Issues Integration** | ||
| 382 | - | ||
| 383 | -* Account is the host of your gitlab installation. i.e. **http://gitlab.example.com** | ||
| 384 | -* To authenticate, Errbit uses token-based authentication. Get your API Key in your user settings (or create special user for this purpose) | ||
| 385 | -* You also need to provide project ID (it needs to be Number) for issues to be created | ||
| 386 | - | ||
| 387 | -**Unfuddle Issues Integration** | ||
| 388 | - | ||
| 389 | -* Account is your unfuddle domain | ||
| 390 | -* Username your unfuddle username | ||
| 391 | -* Password your unfuddle password | ||
| 392 | -* Project id the id of your project where your ticket is create | ||
| 393 | -* Milestone id the id of your milestone where your ticket is create | ||
| 394 | - | ||
| 395 | -**Jira Issue Integration** | 354 | +Issue Trackers |
| 355 | +-------------- | ||
| 356 | +Each issue tracker integration is implemented as a gem that depends on | ||
| 357 | +[errbit_plugin](https://github.com/errbit/errbit_plugin). The only officially | ||
| 358 | +supported issue tracker plugin is | ||
| 359 | +[errbit_github_plugin](https://github.com/errbit/errbit_github_plugin). | ||
| 396 | 360 | ||
| 397 | -* base_url the jira URL | ||
| 398 | -* context_path Context Path (Just "/" if empty otherwise with leading slash) | ||
| 399 | -* username HTTP Basic Auth User | ||
| 400 | -* password HTTP Basic Auth Password | ||
| 401 | -* project_id The project Key where the issue will be created | ||
| 402 | -* account Assign to this user. If empty, Jira takes the project default. | ||
| 403 | -* issue_component Website - Other | ||
| 404 | -* issue_type Issue type | ||
| 405 | -* issue_priority Priority | 361 | +If you want to implement your own issue tracker plugin, read the README.md file |
| 362 | +at [errbit_plugin](https://github.com/errbit/errbit_plugin). | ||
| 406 | 363 | ||
| 407 | Notification Service | 364 | Notification Service |
| 408 | -------------------- | 365 | -------------------- |
| 409 | - | ||
| 410 | **Flowdock Notification** | 366 | **Flowdock Notification** |
| 411 | 367 | ||
| 412 | Allow notification to [Flowdock](https://www.flowdock.com/). See | 368 | Allow notification to [Flowdock](https://www.flowdock.com/). See |