From e92a05822f1fb512f7441a69b3654d30de146b9e Mon Sep 17 00:00:00 2001 From: doruk batur Date: Wed, 22 Jan 2025 17:41:13 +0300 Subject: [PATCH 1/8] BE-5392 Add Git Provider Hook FAQ for Trigger errors * FAQ topic is created * Ensuring triggers are working FAQ is added * How to enable triggers for AWS CodeCommit repositories, section is getting under FAQ --- .../build-manually-or-with-triggers.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index bf6ae4173..e6d92cd40 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -162,6 +162,48 @@ You can specify branch names or tags with an asterisk wildcard to automate build | `fix-*-build` | Build if it starts with `fix-` and ends with `-build` | | `*` | Build everything | +## FAQ + +### How can i check my triggers is working in my Appcircle Build Profiles? + +First of all, it should be ensured that the Build Profile Triggers are set for the desired branches and actions. + +To properly work with Triggers, webhooks in the repositories are used by Appcircle. Also should be ensured that repository has webhook access to Appcircle. In order for webhooks to be connected, Git Provider connection needs to be set proper while creating a Build Profile. + +Certain Git Actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in Git Provider's repository. + +To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git Providers down below. The steps in the Git Provider's Documentations can be followed to access the webhook event history. + +- [**Checking GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) + +- [**Checking GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) + +:::caution GitLab Webhook Request History + +Gitlab provides users a Webhook Test Event, however Appcircle does not initiates a Build Sequence with Webhook Test Events in GitLab. + +::: + +- [**Checking Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) + +:::info Azure DevOps Webhook Event History + +In this Azure DevOps Webhooks Document, reaching Service Hooks is enough for checking Webhook histories. + +::: + +- [**Checking Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) + +:::info Bitbucket Webhook Event History + +A document detailing the history of webhooks is not provided by the Bitbucket. However, webhook histories can be observed by navigating to the webhook section within the repository. + +Bitbucket -> Repository -> Repository Settings -> Webhooks + +::: + +After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git Actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle Build Sequence automatically. + ### How to enable triggers for AWS CodeCommit repositories? Appcircle supports AWS CodeCommit triggers through an Amazon SNS topic. From f8b1bbde4bec21aef296ff452186d218c0e925a0 Mon Sep 17 00:00:00 2001 From: doruk batur Date: Thu, 23 Jan 2025 13:16:38 +0300 Subject: [PATCH 2/8] Review fix requests from BurakO. --- .../build-manually-or-with-triggers.md | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index e6d92cd40..daa0c6b31 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -164,9 +164,9 @@ You can specify branch names or tags with an asterisk wildcard to automate build ## FAQ -### How can i check my triggers is working in my Appcircle Build Profiles? +### How can I check my triggers is working in my Appcircle Build Profiles? -First of all, it should be ensured that the Build Profile Triggers are set for the desired branches and actions. +First of all, it should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in documentation. To properly work with Triggers, webhooks in the repositories are used by Appcircle. Also should be ensured that repository has webhook access to Appcircle. In order for webhooks to be connected, Git Provider connection needs to be set proper while creating a Build Profile. @@ -174,34 +174,35 @@ Certain Git Actions to the repositories, such as push, merge, pull request, tag To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git Providers down below. The steps in the Git Provider's Documentations can be followed to access the webhook event history. -- [**Checking GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) +- [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) -- [**Checking GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) +- [**GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) :::caution GitLab Webhook Request History -Gitlab provides users a Webhook Test Event, however Appcircle does not initiates a Build Sequence with Webhook Test Events in GitLab. +Gitlab provides users a `webhook test event`, however Appcircle does **not initiates** a build sequence with webhook test events in GitLab. ::: -- [**Checking Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) +- [**Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) :::info Azure DevOps Webhook Event History -In this Azure DevOps Webhooks Document, reaching Service Hooks is enough for checking Webhook histories. +In this Azure DevOps webhooks document, reaching service hooks is enough for checking **webhook histories**. ::: -- [**Checking Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) +- [**Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) :::info Bitbucket Webhook Event History -A document detailing the history of webhooks is not provided by the Bitbucket. However, webhook histories can be observed by navigating to the webhook section within the repository. +A document detailing the history of webhooks is **not provided** by the **Bitbucket**. However, webhook histories can be observed by navigating to the webhook section within the repository. -Bitbucket -> Repository -> Repository Settings -> Webhooks +Please navigate to: +**Bitbucket -> Repository -> Repository Settings -> Webhooks** ::: - +After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle build sequence automatically. After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git Actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle Build Sequence automatically. ### How to enable triggers for AWS CodeCommit repositories? From 4bb01937355976b416a6072c258b06d7d0e9aaaf Mon Sep 17 00:00:00 2001 From: doruk batur Date: Thu, 23 Jan 2025 16:40:40 +0300 Subject: [PATCH 3/8] Removed duplicated line, line 205,206 --- .../build-process-management/build-manually-or-with-triggers.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index daa0c6b31..9ee563f47 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -203,7 +203,6 @@ Please navigate to: ::: After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle build sequence automatically. -After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git Actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle Build Sequence automatically. ### How to enable triggers for AWS CodeCommit repositories? From df28771a8be128d575c9bf0898dcaf217680383e Mon Sep 17 00:00:00 2001 From: doruk batur Date: Thu, 23 Jan 2025 18:34:52 +0300 Subject: [PATCH 4/8] Review fix requests from F.Zehra --- .../build-manually-or-with-triggers.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index 9ee563f47..7eb005880 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -164,15 +164,15 @@ You can specify branch names or tags with an asterisk wildcard to automate build ## FAQ -### How can I check my triggers is working in my Appcircle Build Profiles? +### How can I check my triggers is working in my Appcircle build profiles? -First of all, it should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in documentation. +First of all, you should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in documentation. -To properly work with Triggers, webhooks in the repositories are used by Appcircle. Also should be ensured that repository has webhook access to Appcircle. In order for webhooks to be connected, Git Provider connection needs to be set proper while creating a Build Profile. +Appcircle is triggered via Git provider's webhooks. To properly work with triggers, webhooks in the repositories are used by Appcircle. Also should be ensured that repository has webhook access to Appcircle. In order for webhooks to be connected, Git provider connection needs to be set proper while creating a build profile. -Certain Git Actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in Git Provider's repository. +Certain Git actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in Git provider's repository. -To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git Providers down below. The steps in the Git Provider's Documentations can be followed to access the webhook event history. +To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git providers down below. The steps in the Git provider's documentations can be followed to access the webhook event history. - [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) @@ -202,7 +202,8 @@ Please navigate to: **Bitbucket -> Repository -> Repository Settings -> Webhooks** ::: -After confirmation of the webhook is created and connection is set and healthy through the Appcircle Build Profile, and the confirmation of the webhook is set and works as expected in a specific Git Provider. Then Git actions such as pushing a code block, which should activate a webhook event, and then should trigger the Appcircle build sequence automatically. + +After confirmation of the webhook is created and connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, then the webhook event should activate the trigger and the Appcircle build sequence automatically. ### How to enable triggers for AWS CodeCommit repositories? From f3c9237fc35b22d0a41ba91920fb32de80c5aa76 Mon Sep 17 00:00:00 2001 From: doruk batur Date: Fri, 24 Jan 2025 10:43:37 +0300 Subject: [PATCH 5/8] Review fixes that is needed discussions with F.Zehra --- .../build-manually-or-with-triggers.md | 21 ++++++------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index 7eb005880..3b87f2579 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -164,7 +164,7 @@ You can specify branch names or tags with an asterisk wildcard to automate build ## FAQ -### How can I check my triggers is working in my Appcircle build profiles? +### Why is my Appcircle trigger not working and how can I fix it? First of all, you should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in documentation. @@ -172,26 +172,16 @@ Appcircle is triggered via Git provider's webhooks. To properly work with trigge Certain Git actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in Git provider's repository. +If webhooks are disabled by many usages or connection based errors, using test events may re-enable webhooks via Git providers. + To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git providers down below. The steps in the Git provider's documentations can be followed to access the webhook event history. - [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) - [**GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) -:::caution GitLab Webhook Request History - -Gitlab provides users a `webhook test event`, however Appcircle does **not initiates** a build sequence with webhook test events in GitLab. - -::: - - [**Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) -:::info Azure DevOps Webhook Event History - -In this Azure DevOps webhooks document, reaching service hooks is enough for checking **webhook histories**. - -::: - - [**Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) :::info Bitbucket Webhook Event History @@ -199,11 +189,12 @@ In this Azure DevOps webhooks document, reaching service hooks is enough for che A document detailing the history of webhooks is **not provided** by the **Bitbucket**. However, webhook histories can be observed by navigating to the webhook section within the repository. Please navigate to: -**Bitbucket -> Repository -> Repository Settings -> Webhooks** +**Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests** +View Requests has to be enabled before requests to be seen. ::: -After confirmation of the webhook is created and connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, then the webhook event should activate the trigger and the Appcircle build sequence automatically. +After confirmation of the webhook is created and connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, then the webhook event should activate the trigger and the Appcircle build automatically. ### How to enable triggers for AWS CodeCommit repositories? From 93e594e01f388229be069acc50dc891c4a12d0b4 Mon Sep 17 00:00:00 2001 From: doruk batur Date: Fri, 24 Jan 2025 15:32:27 +0300 Subject: [PATCH 6/8] After reviews and changes grammar errors occured and fixed with quillbot --- .../build-manually-or-with-triggers.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index 3b87f2579..cf8b1afea 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -166,15 +166,15 @@ You can specify branch names or tags with an asterisk wildcard to automate build ### Why is my Appcircle trigger not working and how can I fix it? -First of all, you should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in documentation. +First of all, you should be ensured that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in the documentation. -Appcircle is triggered via Git provider's webhooks. To properly work with triggers, webhooks in the repositories are used by Appcircle. Also should be ensured that repository has webhook access to Appcircle. In order for webhooks to be connected, Git provider connection needs to be set proper while creating a build profile. +Appcircle is triggered via the Git provider's webhooks. To properly work with triggers, webhooks in the repositories are used by Appcircle. Also, it should be ensured that the repository has webhook access to Appcircle. In order for webhooks to be connected, the Git provider connection needs to be set properly while creating a build profile. -Certain Git actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in Git provider's repository. +Certain Git actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repositories webhooks. It is a necessity to ensure that the desired event is actually triggered by the action in the Git provider's repository. -If webhooks are disabled by many usages or connection based errors, using test events may re-enable webhooks via Git providers. +If webhooks are disabled by many usages or connection-based errors, using test events may re-enable webhooks via Git providers. -To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Lets have a check with Git providers down below. The steps in the Git provider's documentations can be followed to access the webhook event history. +To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Let's have a check with Git providers down below. The steps in the Git provider's documentation can be followed to access the webhook event history. - [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) @@ -186,15 +186,15 @@ To ensure webhooks are set and working, the webhook histories may be reviewed wi :::info Bitbucket Webhook Event History -A document detailing the history of webhooks is **not provided** by the **Bitbucket**. However, webhook histories can be observed by navigating to the webhook section within the repository. +A document detailing the history of webhooks is not provided by Bitbucket. However, webhook histories can be observed by navigating to the webhook section within the repository. Please navigate to: -**Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests** -View Requests has to be enabled before requests to be seen. +Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests +View Requests has to be enabled before requests can be seen. ::: -After confirmation of the webhook is created and connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, then the webhook event should activate the trigger and the Appcircle build automatically. +After confirmation of the webhook is created and the connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, and then the webhook event should activate the trigger and the Appcircle build automatically. ### How to enable triggers for AWS CodeCommit repositories? From 01ef4dde5ea9ef307dd0f0fb6aa7782428a961bf Mon Sep 17 00:00:00 2001 From: doruk batur Date: Mon, 27 Jan 2025 12:27:23 +0300 Subject: [PATCH 7/8] Review fix request from BurakO. --- .../build-manually-or-with-triggers.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index cf8b1afea..024e884ea 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -189,7 +189,8 @@ To ensure webhooks are set and working, the webhook histories may be reviewed wi A document detailing the history of webhooks is not provided by Bitbucket. However, webhook histories can be observed by navigating to the webhook section within the repository. Please navigate to: -Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests +**Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests** + View Requests has to be enabled before requests can be seen. ::: From 0f83c2e195f496bf76a8dc0b91b3f0cc65a1067c Mon Sep 17 00:00:00 2001 From: doruk batur Date: Tue, 28 Jan 2025 10:32:22 +0300 Subject: [PATCH 8/8] Review nice to have request from F.Zehra --- .../build-manually-or-with-triggers.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index 024e884ea..2c40e3f8c 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -177,25 +177,25 @@ If webhooks are disabled by many usages or connection-based errors, using test e To ensure webhooks are set and working, the webhook histories may be reviewed within the Git providers. Let's have a check with Git providers down below. The steps in the Git provider's documentation can be followed to access the webhook event history. - [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) - - [**GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) - - [**Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) - - [**Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) :::info Bitbucket Webhook Event History -A document detailing the history of webhooks is not provided by Bitbucket. However, webhook histories can be observed by navigating to the webhook section within the repository. +A document detailing the history of webhooks is not provided by Bitbucket. To access the webhook history please navigate to: -Please navigate to: **Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests** View Requests has to be enabled before requests can be seen. ::: -After confirmation of the webhook is created and the connection is set and healthy through the Appcircle build profile, and the confirmation of the webhook is set and works as expected in a specific Git provider. Then Git actions such as pushing a code block, which should activate a webhook event, and then the webhook event should activate the trigger and the Appcircle build automatically. +Once the webhook is created and confirmed to be properly set up and healthy in the Appcircle build profile, and it is verified to work correctly with the specific Git provider, the process works as follows: + +- A Git action, such as pushing a code block, triggers a webhook event. +- This webhook event activates the trigger in Appcircle. +- Appcircle then automatically starts the build process. ### How to enable triggers for AWS CodeCommit repositories?