Skip to content

Commit

Permalink
docs: document version availability
Browse files Browse the repository at this point in the history
  • Loading branch information
@fallion
fallion committed Jun 25, 2020
1 parent 05105b7 commit 5416b8d
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions www/docs/configuration/config-file.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ version: 1
verbose: false
```
| Name | Default Value | Description |
| ------- | ------------- | ----------------------------------------------------------------------------------- |
| version | 1 | Currently not in use. Might be used in the future in case of incompatible upgrades. |
| verbose | false | Turns on debug logging of commitsar. Useful if you want to submit an issue. |
| Name | Default Value | Description | Available from |
| ------- | ------------- | ----------------------------------------------------------------------------------- | -------------- |
| version | 1 | Currently not in use. Might be used in the future in case of incompatible upgrades. | v0.14.0 |
| verbose | false | Turns on debug logging of commitsar. Useful if you want to submit an issue. | v0.14.0 |
## Commit style settings
Expand All @@ -37,12 +37,12 @@ commits:
all: false
```
| Name | Default Value | Description |
| -------- | ------------- | --------------------------------------------------------------------------------------------- |
| disabled | false | Disables checking commmits. Useful if you want to use commitsar only for PR titles. |
| strict | true | Enforces strict category enforcement. |
| limit | none | Makes commitsar check only the last x commits. Useful if you want to run commitsar on master. |
| all | false | Makes commitsar check all the commits in history. **Overrides the `limit` flag** |
| Name | Default Value | Description | Available from |
| -------- | ------------- | --------------------------------------------------------------------------------------------- | -------------- |
| disabled | false | Disables checking commmits. Useful if you want to use commitsar only for PR titles. | v0.14.0 |
| strict | true | Enforces strict category enforcement. | v0.14.0 |
| limit | none | Makes commitsar check only the last x commits. Useful if you want to run commitsar on master. | v0.14.0 |
| all | false | Makes commitsar check all the commits in history. **Overrides the `limit` flag** | v0.14.0 |

## Pull Request style settings

Expand All @@ -58,7 +58,7 @@ pull_request:

Setting `jira_title` to true will enable the pipeline. By default commitsar will use a basic regex to check for any JIRA-like references. Further scoping can be done using the `jira_keys` setting.

| Name | Default Value | Description |
| ---------- | ------------- | --------------------------------------------------------------------- |
| jira_title | false | Turns on the pipeline and will check for JIRA issues in the PR title. |
| jira_keys | none | Array of string project keys from JIRA. |
| Name | Default Value | Description | Available from |
| ---------- | ------------- | --------------------------------------------------------------------- | -------------- |
| jira_title | false | Turns on the pipeline and will check for JIRA issues in the PR title. | v0.15.0 |
| jira_keys | none | Array of string project keys from JIRA. | v0.15.0 |

1 comment on commit 5416b8d

@vercel
Copy link

@vercel vercel bot commented on 5416b8d Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to following URLs:

Please sign in to comment.