From cd6104ff008565bd7eb9d98f1469c7b7792b229a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santos?= Date: Thu, 2 Apr 2015 08:48:53 +0200 Subject: [PATCH] https://github.com/zalando-bus/turnstile/issues/2 Updated the documentation --- .turnstile.yml | 9 --------- docs/dev/specifications.md | 23 +++-------------------- docs/user/configuration.md | 5 +---- turnstile.yml.example | 11 ----------- 4 files changed, 4 insertions(+), 44 deletions(-) diff --git a/.turnstile.yml b/.turnstile.yml index decd34b..3fbc978 100644 --- a/.turnstile.yml +++ b/.turnstile.yml @@ -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|\_|\.)+$' diff --git a/docs/dev/specifications.md b/docs/dev/specifications.md index 28dcd5b..c71caed 100644 --- a/docs/dev/specifications.md +++ b/docs/dev/specifications.md @@ -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. \ No newline at end of file +Commit specifications are urlencoded absolute uniform resource identifiers (URI). The specification must be the first +“word” of the commit. \ No newline at end of file diff --git a/docs/user/configuration.md b/docs/user/configuration.md index 1dfbe5e..22ee0f0 100644 --- a/docs/user/configuration.md +++ b/docs/user/configuration.md @@ -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 diff --git a/turnstile.yml.example b/turnstile.yml.example index 9f88609..c2a913e 100644 --- a/turnstile.yml.example +++ b/turnstile.yml.example @@ -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'