GitLab Integration

docs/features.rst

@@ -3,8 +3,8 @@ Read the Docs features
 
 This will serve as a list of all of the features that Read the Docs currently has. Some features are important enough to have their own page in the docs, others will simply be listed here.
 
-GitHub and Bitbucket Integration
---------------------------------
+GitHub, Bitbucket and GitLab Integration
+----------------------------------------
 
 We now support linking by default in the sidebar. It links to the page on your host, which should help people quickly update typos and send pull requests to contribute to project documentation.
 
@@ -66,4 +66,3 @@ Alternate Domains
 -----------------
 
 We provide support for CNAMEs, subdomains, and a shorturl for your project as well. This is outlined in the :doc:`alternate_domains` section.
-

docs/getting_started.rst

@@ -88,15 +88,13 @@ Then in your ``conf.py``:
 Sign Up and Connect an External Account
 ---------------------------------------
 
-.. TODO Update this with GitLab support later
-
-If you are going to import a repository from GitHub or Bitbucket, you should
+If you are going to import a repository from GitHub, Bitbucket or GitLab, you should
 connect your account to your provider first. Connecting your account allows for
 easier importing and enables Read the Docs to configure your repository webhooks
 automatically.
 
 To connect your account, got to your *Settings* dashboard and select *Connected
-Services*. From here, you'll be able to connect to your GitHub or Bitbucket
+Services*. From here, you'll be able to connect to your GitHub, Bitbucket or GitLab
 account. This process will ask you to authorize a connection to Read the Docs,
 that allows us to read information about and clone your repositories.
 

docs/webhooks.rst

@@ -3,7 +3,7 @@ Webhooks
 
 The primary method that Read the Docs uses to detect changes to your
 documentation is through the use of *webhooks*. Webhooks are configured with
-your repository provider, such as GitHub or Bitbucket, and with each commit,
+your repository provider, such as GitHub, Bitbucket or GitLab, and with each commit,
 merge, or other change to your repository, Read the Docs is notified. When we
 receive a webhook notification, we determine if the change is related to an
 active version for your project, and if it is, a build is triggered for that

readthedocs/builds/models.py

@@ -21,8 +21,8 @@
 
 from readthedocs.core.utils import broadcast
 from readthedocs.projects.constants import (
-    BITBUCKET_REGEXS, BITBUCKET_URL, GITHUB_REGEXS, GITHUB_URL, PRIVACY_CHOICES,
-    PRIVATE)
+    BITBUCKET_REGEXS, BITBUCKET_URL, GITHUB_REGEXS, GITHUB_URL, GITLAB_REGEXS,
+    GITLAB_URL, PRIVACY_CHOICES, PRIVATE)
 from readthedocs.projects.models import APIProject, Project
 
 from .constants import (
@@ -113,7 +113,7 @@ def commit_name(self):
         Return the branch name, the tag name or the revision identifier.
 
         The result could be used as ref in a git repo, e.g. for linking to
-        GitHub or Bitbucket.
+        GitHub, Bitbucket or GitLab.
         """
         # LATEST is special as it is usually a branch but does not contain the
         # name in verbose_name.
@@ -295,6 +295,44 @@ def get_github_url(
             action=action_string,
         )
 
+    def get_gitlab_url(
+            self, docroot, filename, source_suffix='.rst', action='view'):
+        repo_url = self.project.repo
+        if 'gitlab' not in repo_url:
+            return ''
+
+        if not docroot:
+            return ''
+        else:
+            if docroot[0] != '/':
+                docroot = '/{}'.format(docroot)
+            if docroot[-1] != '/':
+                docroot = '{}/'.format(docroot)
+
+        if action == 'view':
+            action_string = 'blob'
+        elif action == 'edit':
+            action_string = 'edit'
+
+        for regex in GITLAB_REGEXS:
+            match = regex.search(repo_url)
+            if match:
+                user, repo = match.groups()
+                break
+        else:
+            return ''
+        repo = repo.rstrip('/')
+
+        return GITLAB_URL.format(
+            user=user,
+            repo=repo,
+            version=self.commit_name,
+            docroot=docroot,
+            path=filename,
+            source_suffix=source_suffix,
+            action=action_string,
+        )
+
     def get_bitbucket_url(self, docroot, filename, source_suffix='.rst'):
         repo_url = self.project.repo
         if 'bitbucket' not in repo_url:

readthedocs/doc_builder/backends/sphinx.py

@@ -82,6 +82,11 @@ def get_config_params(self):
         bitbucket_version_is_editable = (self.version.type == 'branch')
         display_bitbucket = bitbucket_user is not None
 
+        gitlab_user, gitlab_repo = version_utils.get_gitlab_username_repo(
+            url=self.project.repo)
+        gitlab_version_is_editable = (self.version.type == 'branch')
+        display_gitlab = gitlab_user is not None
+
         # Avoid hitting database and API if using Docker build environment
         if getattr(settings, 'DONT_HIT_API', False):
             versions = self.project.active_versions()
@@ -119,6 +124,13 @@ def get_config_params(self):
             'bitbucket_version': remote_version,
             'bitbucket_version_is_editable': bitbucket_version_is_editable,
             'display_bitbucket': display_bitbucket,
+
+            # GitLab
+            'gitlab_user': gitlab_user,
+            'gitlab_repo': gitlab_repo,
+            'gitlab_version': remote_version,
+            'gitlab_version_is_editable': gitlab_version_is_editable,
+            'display_gitlab': display_gitlab,
         }
 
         finalize_sphinx_context_data.send(

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

@@ -105,6 +105,10 @@ context = {
     'bitbucket_repo': '{{ bitbucket_repo }}',
     'bitbucket_version': '{{ bitbucket_version }}',
     'display_bitbucket': {{ display_bitbucket }},
+    'gitlab_user': '{{ gitlab_user }}',
+    'gitlab_repo': '{{ gitlab_repo }}',
+    'gitlab_version': '{{ gitlab_version }}',
+    'display_gitlab': {{ display_gitlab }},
     'READTHEDOCS': True,
     'using_theme': (html_theme == "default"),
     'new_theme': (html_theme == "sphinx_rtd_theme"),

readthedocs/integrations/models.py

@@ -306,6 +306,22 @@ def can_sync(self):
             return False
 
 
+class GitLabWebhook(Integration):
+
+    integration_type_id = Integration.GITLAB_WEBHOOK
+    has_sync = True
+
+    class Meta(object):
+        proxy = True
+
+    @property
+    def can_sync(self):
+        try:
+            return all((k in self.provider_data) for k in ['id', 'url'])
+        except (ValueError, TypeError):
+            return False
+
+
 class GenericAPIWebhook(Integration):
 
     integration_type_id = Integration.API_WEBHOOK

readthedocs/projects/constants.py

@@ -291,9 +291,17 @@
     re.compile('bitbucket.org/(.+)/(.+)/'),
     re.compile('bitbucket.org/(.+)/(.+)'),
 ]
+GITLAB_REGEXS = [
+    re.compile('gitlab.com/(.+)/(.+)(?:\.git){1}'),
+    re.compile('gitlab.com/(.+)/(.+)'),
+    re.compile('gitlab.com:(.+)/(.+).git'),
+]
 GITHUB_URL = (
     'https://github.com/{user}/{repo}/'
     '{action}/{version}{docroot}{path}{source_suffix}')
 BITBUCKET_URL = (
     'https://bitbucket.org/{user}/{repo}/'
     'src/{version}{docroot}{path}{source_suffix}')
+GITLAB_URL = (
+    'https://gitlab.com/{user}/{repo}/'
+    '{action}/{version}{docroot}{path}{source_suffix}')

readthedocs/projects/views/base.py

@@ -35,15 +35,15 @@ def get_context_data(self, **kwargs):
         onboard = {}
         project = self.get_object()
 
-        # TODO: gitlab
-
         # Show for the first few builds, return last build state
         if project.builds.count() <= 5:
             onboard['build'] = project.get_latest_build(finished=False)
             if 'github' in project.repo:
                 onboard['provider'] = 'github'
             elif 'bitbucket' in project.repo:
                 onboard['provider'] = 'bitbucket'
+            elif 'gitlab' in project.repo:
+                onboard['provider'] = 'gitlab'
             context['onboard'] = onboard
 
         return context

readthedocs/restapi/templates/restapi/footer.html

@@ -93,6 +93,16 @@
           <a href="{{ bitbucket_url }}">Edit</a>
         </dd>
       </dl>
+      {% elif gitlab_edit_url %}
+      <dl>
+        <dt>On GitLab</dt>
+        <dd>
+          <a href="{{ gitlab_view_url }}">View</a>
+        </dd>
+        <dd>
+          <a href="{{ gitlab_edit_url }}">Edit</a>
+        </dd>
+      </dl>
       {% endif %}
       {% endblock %}
 
@@ -113,7 +123,7 @@
 
       <hr/>
       {% block footer %}
-      Free document hosting provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+      Free document hosting provided by <a href="https://readthedocs.org">Read the Docs</a>.
       {% endblock %}
 
       {% if not new_theme %}