GitLab

Created by: rpdai

Several people have been getting 500 errors on configuring redmine (#5236 (closed), #6616 (closed)). I suspect that the gitlab.yml.example is not being followed correctly. The spaces between the sections providing the project_url, issues_url, and new_issue_url, means it is easy to uncomment only the project_url section. This is a natural mistake. Leaving the required properties commented for the issue tracker leads to the 500 error exactly as described in #6616 (closed).

As a further consequence, the description of these properties is misleading. They suggest they do something "if not nil" but they appear to be mandatory configuration properties for each issue tracker.

I'd suggest cleaning up the example. As a minimum, removing the spaces between the comments on the properties would help avoid this mistake. Maybe it can be reorganized further, so instead of this:

## External issues trackers
  issues_tracker:
    # redmine:
    #   title: "Redmine"
    #   ## If not nil, link 'Issues' on project page will be replaced with this
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   project_url: "http://redmine.sample/projects/:issues_tracker_id"
    #
    #   ## If not nil, links from /#\d/ entities from commit messages will replaced with this
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   ##  :id                - Issue id (from commit messages)
    #   issues_url: "http://redmine.sample/issues/:id"
    #
    #   ## If not nil, links to creating new issues will be replaced with this
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   new_issue_url: "http://redmine.sample/projects/:issues_tracker_id/issues/new"
    #
    # jira:
    #   title: "Atlassian Jira"
    #   project_url: "http://jira.sample/issues/?jql=project=:issues_tracker_id"
    #   issues_url: "http://jira.sample/browse/:id"
    #   new_issue_url: "http://jira.sample/secure/CreateIssue.jspa"

Simplify it to this:

## External issues trackers
  issues_tracker:
    #   ##
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   ##  :id                - Issue id (from commit messages)
    #   ##
    #   ## The 'title' is how the issue tracker will appear in the project settings.
    #   ## The 'project_url' links to the project in the issue tracker (from the gitlab project).
    #   ## The 'issues_url' links occurances of /#\d/ to a specific issue in the issue tracker (for
    #   ## example #1234 in a commit message would link to issue 1234 in the issue tracker).
    #   ## The 'new_issue_url' provides a link to create a new issue against the project.
    #
    # redmine:
    #   title: "Redmine"
    #   project_url: "http://redmine.sample/projects/:issues_tracker_id"
    #   issues_url: "http://redmine.sample/issues/:id"
    #   new_issue_url: "http://redmine.sample/projects/:issues_tracker_id/issues/new"
    #
    # jira:
    #   title: "Atlassian Jira"
    #   project_url: "http://jira.sample/issues/?jql=project=:issues_tracker_id"
    #   issues_url: "http://jira.sample/browse/:id"
    #   new_issue_url: "http://jira.sample/secure/CreateIssue.jspa"