Skip to content

Commit

Permalink
#2 Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcs committed Apr 2, 2015
1 parent 6091e7d commit cd6104f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 44 deletions.
9 changes: 0 additions & 9 deletions .turnstile.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
checks:
- specification
- branch-has-specification
- allowed-project
- branch-release
- codevalidator
specification:
format: 'jira'
branch-has-specification:
exceptions:
- '^release/'
allowed-project:
allowed:
- PF
- CD
branch-release:
pattern: '^v(?:\d|\_|\.)+$'
23 changes: 3 additions & 20 deletions docs/dev/specifications.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,7 @@
Commit Specification
====================

Overview
--------
Commit specifications are urlencoded uniform resource identifiers (URI). The specification must be the first “word” of
the commit and can optionally start with a ‘#’ character that is ignored. For readability purposes the scheme of the
specification URI can be omitted if the same as the default for the repository.


Schemes
-------
### Generic
Generic specification without a special meaning. Generic specifications are always valid.
This format is used by default if scheme is missing from the URI and there is no default scheme for the repository.

### JIRA
JIRA specification URIs take the form of “jira:PROJECT-TICKET_NUMBER” for example “jira:CD-123

### Github
Github specifications URIs take the form of “github:ISSUE_NUMBER” where ISSUE_NUMBER is the number of the specification
on the repository

### HTTP(S)
Specifications can also be http and https urls.
Commit specifications are urlencoded absolute uniform resource identifiers (URI). The specification must be the first
“word” of the commit.
5 changes: 1 addition & 4 deletions docs/user/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ Common Parameters

Check Parameters
----------------
Some checks have check specific configuration that can be specified in a parameter with the check name.
Some checks have check specific configuration that can be specified in a parameter with the check name.
Please look in the check documentation for more information.

List of checks
--------------
- [Allowed Projects](checks/allowed-project.md) - Check if commit is from an allowed JIRA project
- [Branch Has Specification](checks/branch-has-specification.md) - Check if branch name contains a reference to the
specification;
- [Branch Pattern](checks/branch-pattern.md) - Check if branch name matches one of the allowed patterns
- [Branch Release](checks/branch-release.md) - Check if release branches names contain a valid release name
- [Branch Type](checks/branch-type.md) - Check if branch type is allowed
Expand Down
11 changes: 0 additions & 11 deletions turnstile.yml.example
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
checks:
- specification
- branch-has-specification
- allowed-project
- branch-pattern
- branch-type
- branch-release
- codevalidator
specification:
format: 'jira'
branch-has-specification:
exceptions:
- '^release/'
allowed-project:
allowed:
- PF
- CD
branch-pattern:
allowed:
- '^release/R'
Expand Down

0 comments on commit cd6104f

Please sign in to comment.