Skip to content

Commit

Permalink
add links to issue trackers (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
preslavmihaylov committed Aug 1, 2020
1 parent 1e148f8 commit e4334f4
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,15 @@ In the example above, it would look for it in `path/to/project/.todocheck.yaml`.
# Supported Issue Trackers
Currently, todocheck supports the following issue trackers:

| Issue Tracker | Description |
|-----------------|--------------------------------------------------|
| Github | Both public & private repositories are supported |
| Gitlab | Both public & private repositories are supported |
| Jira | Supported via offline tokens |
| Pivotal Tracker | Supported via an API token |

## Github
| Issue Tracker | Description |
|-------------------------------------------------|-----------------------------------------------------------------------|
| [Github](https://github.com) | Both public & private repositories are supported |
| [Gitlab](https://gitlab.com/) | Both public & private repositories are supported |
| [Jira](https://www.atlassian.com/software/jira) | Supported via offline tokens |
| [Pivotal Tracker](https://pivotaltracker.com/) | Supported via an API token |
| [Redmine](https://redmine.org/) | Supports public access with no auth & private access via an API token |

## [Github](https://github.com)
To integrate with a public github repository, specify the origin of your repo and the `GITHUB` issue tracker in your `.todocheck.yaml` configuration:
```
origin: github.com/user/repository
Expand All @@ -122,7 +123,7 @@ The first time you run the application, it will ask for your [personal access to

After you've specified it, it will store it in the auth tokens cache for subsequent executions. See the [Authentication](#authentication) section for more info.

## Gitlab
## [Gitlab](https://gitlab.com)
To integrate with a public gitlab repository, specify the origin of your repo and the `GITLAB` issue tracker in your `.todocheck.yaml` configuration:
```
origin: gitlab.com/user/repository
Expand All @@ -141,7 +142,7 @@ The first time you run the application, it will ask for your [personal access to

After you've specified it, it will store it in the auth tokens cache for subsequent executions. See the [Authentication](#authentication) section for more info.

## Jira
## [Jira](https://www.atlassian.com/software/jira)
To integrate with your organization's Jira, you'll need to specify `JIRA` as your issue tracker, the origin of your jira server instance, along with an [offline token](#api-tokenoffline-token):
```
origin: https://myjira.awesomeorg.com
Expand All @@ -161,7 +162,7 @@ After you've given the offline token to `todocheck`'s prompt, it will store it i

See the [Authentication](#authentication) section for more info.

## Pivotal Tracker
## [Pivotal Tracker](https://pivotaltracker.com/)
To integrate with a pivotal tracker project, specify the origin of your project and the `PIVOTAL_TRACKER` issue tracker in your `.todocheck.yaml` configuration.
You should also specify the `apitoken` as an auth type:
```
Expand All @@ -183,7 +184,7 @@ For example:
// TODO #123456: This one is not
```

## Redmine
## [Redmine](https://redmine.org)
To integrate with a redmine issue tracker project, specify the origin of your installation (without project path) and the `REDMINE` issue tracker in your `.todocheck.yaml` configuration.

You should also specify the `apitoken` as an auth type if you have authentication enabled on your server:
Expand Down

0 comments on commit e4334f4

Please sign in to comment.