From 58a8510d4966568b4f43c0109e80d2df96ab4ab1 Mon Sep 17 00:00:00 2001 From: Krzysztof Dukszta-Kwiatkowski Date: Tue, 6 Jun 2023 12:14:08 +0200 Subject: [PATCH 1/3] feat: gitlab integration documentation --- packages/docs/pages/apps/gitlab/connection.md | 18 ++++++++++ packages/docs/pages/apps/gitlab/triggers.md | 36 +++++++++++++++++++ packages/docs/pages/guide/available-apps.md | 1 + 3 files changed, 55 insertions(+) create mode 100644 packages/docs/pages/apps/gitlab/connection.md create mode 100644 packages/docs/pages/apps/gitlab/triggers.md diff --git a/packages/docs/pages/apps/gitlab/connection.md b/packages/docs/pages/apps/gitlab/connection.md new file mode 100644 index 00000000..d4523024 --- /dev/null +++ b/packages/docs/pages/apps/gitlab/connection.md @@ -0,0 +1,18 @@ +# Gitlab + +:::info +This page explains the steps you need to follow to set up the Gitlab +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to the [link](https://gitlab.com/-/profile/applications) to register a **new OAuth application** on Gitlab. +2. Fill application **Name**. +3. Copy **OAuth Redirect URL** from Automatisch to **Redirect URI** field on Gitlab page. +4. Mark the **Confidential** field on Gitlab page. +5. Mark the **api** and **read_user** in **Scopes** section on Gitlab page. +6. Click on the **Save application** button at the end of the form on Gitlab page. +7. Copy the **Application ID** value from the following page to the `Client ID` field on Automatisch. +8. Copy the **Secret** value from the same page to the `Client Secret` field on Automatisch. +9. Click **Continue** button on Gitlab page. +10. Click **Submit** button on Automatisch. +11. Congrats! Start using your new Github connection within the flows. diff --git a/packages/docs/pages/apps/gitlab/triggers.md b/packages/docs/pages/apps/gitlab/triggers.md new file mode 100644 index 00000000..1eee67cb --- /dev/null +++ b/packages/docs/pages/apps/gitlab/triggers.md @@ -0,0 +1,36 @@ +--- +favicon: /favicons/gitlab.svg +items: + - name: Confidential issue event + desc: Triggers when a new confidential issue is created or an existing issue is updated, closed, or reopened + - name: Confidential comment event + desc: Triggers when a new confidential comment is made on commits, merge requests, issues, and code snippets + - name: Deployment event + desc: Triggers when a deployment starts, succeeds, fails or is canceled + - name: Feature flag event + desc: Triggers when a feature flag is turned on or off + - name: Issue event + desc: Triggers when a new issue is created or an existing issue is updated, closed, or reopened + - name: Job event + desc: Triggers when the status of a job changes + - name: Merge request event + desc: Triggers when merge request is created, updated, or closed + - name: Comment event + desc: Triggers when a new comment is made on commits, merge requests, issues, and code snippets + - name: Pipeline event + desc: Triggers when the status of a pipeline changes + - name: Push event + desc: Triggers when you push to the repository + - name: Release event + desc: Triggers when a release is created or updated + - name: Tag event + desc: Triggers when you create or delete tags in the repository + - name: Wiki page event + desc: Triggers when a wiki page is created, updated, or deleted +--- + + + + diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 0ce759c2..6dc26131 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -13,6 +13,7 @@ Following integrations are currently supported by Automatisch. - [Filter](/apps/filter/actions) - [Flickr](/apps/flickr/triggers) - [Github](/apps/github/triggers) +- [Gitlab](/apps/gitlab/triggers) - [Google Drive](/apps/google-drive/triggers) - [Google Forms](/apps/google-forms/triggers) - [Google Sheets](/apps/google-sheets/triggers) From d06a89564faf5aef72def7dfc49165b2341be952 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Mon, 12 Jun 2023 12:30:17 +0200 Subject: [PATCH 2/3] docs: Add GitLab favicon --- packages/docs/pages/public/favicons/gitlab.svg | 1 + 1 file changed, 1 insertion(+) create mode 100644 packages/docs/pages/public/favicons/gitlab.svg diff --git a/packages/docs/pages/public/favicons/gitlab.svg b/packages/docs/pages/public/favicons/gitlab.svg new file mode 100644 index 00000000..1c7cb071 --- /dev/null +++ b/packages/docs/pages/public/favicons/gitlab.svg @@ -0,0 +1 @@ + From 49d9f77d1bbe76ca71e20aa3cf3d45c17c0f51f7 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Mon, 12 Jun 2023 12:30:29 +0200 Subject: [PATCH 3/3] docs: Add GitLab to available apps --- packages/docs/pages/.vitepress/config.js | 11 ++++++++++- packages/docs/pages/guide/available-apps.md | 4 ++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 597d497d..905b7913 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -87,7 +87,7 @@ export default defineConfig({ ], }, { - text: 'Github', + text: 'GitHub', collapsible: true, collapsed: true, items: [ @@ -96,6 +96,15 @@ export default defineConfig({ { text: 'Connection', link: '/apps/github/connection' }, ], }, + { + text: 'GitLab', + collapsible: true, + collapsed: true, + items: [ + { text: 'Triggers', link: '/apps/gitlab/triggers' }, + { text: 'Connection', link: '/apps/gitlab/connection' }, + ], + }, { text: 'Google Drive', collapsible: true, diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 6dc26131..6d6a48ff 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -12,8 +12,8 @@ Following integrations are currently supported by Automatisch. - [Dropbox](/apps/dropbox/actions) - [Filter](/apps/filter/actions) - [Flickr](/apps/flickr/triggers) -- [Github](/apps/github/triggers) -- [Gitlab](/apps/gitlab/triggers) +- [GitHub](/apps/github/triggers) +- [GitLab](/apps/gitlab/triggers) - [Google Drive](/apps/google-drive/triggers) - [Google Forms](/apps/google-forms/triggers) - [Google Sheets](/apps/google-sheets/triggers)