|
| 1 | +Git provider integrations |
| 2 | +========================= |
| 3 | + |
| 4 | +Your Read the Docs account can be connected to your Git provider's account. |
| 5 | +Connecting your account provides the following features: |
| 6 | + |
| 7 | +🔑️ Easy login |
| 8 | + Log in to Read the Docs with your |git_providers_or| account. |
| 9 | + |
| 10 | +🔁️ List your projects |
| 11 | + Select a project to automatically import from all your Git repositories and organizations. |
| 12 | + See: :doc:`/intro/import-guide`. |
| 13 | + |
| 14 | +⚙️ Automatic configuration |
| 15 | + Have your Git repository automatically configured with your Read the Docs :term:`webhook`, |
| 16 | + which allows Read the Docs to build your docs on every change to your repository. |
| 17 | + |
| 18 | +🚥️ Commit status |
| 19 | + See your documentation build status as a commit status indicator on :doc:`pull request builds </pull-requests>`. |
| 20 | + |
| 21 | +.. note:: |
| 22 | + |
| 23 | + **Are you using GitHub Enterprise?** |
| 24 | + We offer customized enterprise plans for organizations. |
| 25 | + |
| 26 | + |
| 27 | + **Other Git providers** |
| 28 | + We also generally support all Git providers through :doc:`manual configuration </guides/setup/git-repo-manual>`. |
| 29 | + |
| 30 | +.. figure:: /img/screenshot-webhook.png |
| 31 | + :alt: Screenshot of the Dashboard view for the incoming webhook |
| 32 | + |
| 33 | + All calls to the incoming webhook are logged. |
| 34 | + Each call can trigger builds and version synchronization. |
| 35 | + |
| 36 | +Read the Docs incoming webhook |
| 37 | +------------------------------ |
| 38 | + |
| 39 | +Accounts with |git_providers_and| integration automatically have Read the Docs' incoming :term:`webhook` configured on all Git repositories that are imported. |
| 40 | +Other setups can setup the webhook through :doc:`manual configuration </guides/setup/git-repo-manual>`. |
| 41 | + |
| 42 | +When an incoming webhook notification is received, |
| 43 | +we ensure that it matches an existing Read the Docs project. |
| 44 | +Once we have validated the webhook, |
| 45 | +we take an action based on the information inside of the webhook. |
| 46 | + |
| 47 | +Possible webhook actions outcomes are: |
| 48 | + |
| 49 | +* :doc:`Builds </builds>` the latest commit. |
| 50 | +* Synchronizes your versions based on the latest tag and branch data in Git. |
| 51 | +* Runs your :doc:`automation rules</automation-rules>`. |
| 52 | +* Auto-cancels any currently running builds of the same version. |
| 53 | + |
| 54 | +Other features enabled by Git integration |
| 55 | +----------------------------------------- |
| 56 | + |
| 57 | +We have additional documentation around features provided by our Git integrations: |
| 58 | + |
| 59 | +.. seealso:: |
| 60 | + |
| 61 | + :doc:`/pull-requests` |
| 62 | + Your Read the Docs project will automatically be configured to send back build notifications, |
| 63 | + which can be viewed as commit statuses and on pull requests. |
| 64 | + |
| 65 | + :ref:`sso_git_provider` |
| 66 | + Git integration makes it possible for us to synchronize your Git repository's access rights from your Git provider. |
| 67 | + That way, the same access rights are effective on Read the Docs and you don't have to configure access in two places. |
0 commit comments