10BC0 Merge branch 'main' into task_t5vkc3/add_end_user_onboarding_page_to_… · port-labs/port-docs@e262fbd · GitHub
[go: up one dir, main page]
Skip to content

Commit e262fbd

Browse files
hadar-cohadar-co
authored
Merge branch 'main' into task_t5vkc3/add_end_user_onboarding_page_to_docs
2 parents ca31749 + 51dc4cf commit e262fbd

File tree

82 files changed

+1933
-415
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+1933
-415
lines changed

‎.github/workflows/updateApiSpec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
# Step 6: Create a pull request with the changes using the hash as the branch name
5252
- name: Create Pull Request
5353
if: steps.diff_check.outputs.diff_found == 'true'
54-
uses: peter-evans/create-pull-request@v7
54+
uses: peter-evans/create-pull-request@v8
5555
with:
5656
token: ${{ secrets.GITHUB_TOKEN }}
5757
branch: update-${{ steps.yaml_hash.outputs.yaml_hash }}

‎docs/actions-and-automations/setup-backend/azure-pipeline/azure-pipeline.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ The steps shown in the image above are as follows:
1010
1. A self-service action or automation is invoked in Port.
1111
2. Port signs the action payload using SHA-1 with your Port [`clientSecret`](/build-your-software-catalog/custom-integration/api/api.md#find-your-port-credentials) value and puts it in the `x-port-signature` request header.
1212

13-
:::info Webhook security
14-
Verifying the webhook request using the request headers provides the following benefits:
13+
Validating the webhook request using the request headers ensures that:
1514

16-
- Ensures that the request payload has not been tampered with.
17-
- Ensures that the sender of the message is Port.
18-
- Ensures that the received message is not a replay of an older message.
15+
- The request payload has not been tampered with.
16+
- The sender of the message is Port.
17< 436E span class="diff-text-marker">+
- The received message is not a replay of an older message.
1918

20-
:::
19+
To learn more, refer to the [validate webhook signature](/actions-and-automations/setup-backend/webhook/signature-verification) page.
2120

2221
3. Port publishes an invoked `WEBHOOK` via a `POST` request to `https://dev.azure.com/{org_name}/_apis/public/distributedtask/webhooks/{webhook_name}?api-version=6.0-preview`
2322

@@ -47,7 +46,8 @@ To define an incoming webhook in Azure, follow the steps below:
4746

4847
2. **Use the Webhook in Your Pipeline**
4948
- Add the service connection resources in the Azure pipeline yaml:
50-
```yaml
49+
50+
```yaml showLineNumbers
5151
resources:
5252
webhooks:
5353
- webhook: { webhookName }

‎docs/actions-and-automations/setup-backend/azure-pipeline/trigger-non-default-branch.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ This approach is useful when you need to:
168168
Here's a complete self-service action that allows users to deploy from different branches:
169169

170170
<details>
171-
<summary><b>Complete action JSON</b></summary>
171+
<summary><b>Complete action JSON (click to expand)</b></summary>
172172

173173
```json showLineNumbers
174174
{

‎docs/actions-and-automations/setup-backend/azure-pipeline/troubleshooting.md‎

Lines changed: 6 additions & 5 deletions
@@ -99,7 +100,7 @@ Follow these steps in order to diagnose and fix common pipeline issues.
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before troubleshooting, ensure you have:
2020

2121
The ADO trigger flow is more complex than other pipelines because it requires multiple components working together:
2222

23-
<img src="/img/self-service-actions/setup-backend/azurepipeline/ADOpipelineFlowImg.png" width="90%" border='1px' />
23+
<img src="/img/self-service-actions/setup-backend/azurepipeline/ADOpipelineFlowImg.png" width="80%" border='1px' />
2424

2525
## Troubleshoot pipeline issues
2626

@@ -54,7 +54,8 @@ Follow these steps in order to diagnose and fix common pipeline issues.
5454
- Check webhook logs for any failed attempts.
5555
- Check if the webhook name matches the one referenced in your pipeline.
5656
- Test webhook manually:
57-
```bash
57+
58+
```bash showLineNumbers
5859
curl -X POST 'https://dev.azure.com/{org_name}/_apis/public/distributedtask/webhooks/{webhook_name}?api-version=6.0-preview' \
5960
-H "Content-Type: application/json" \
6061
-d '{
99100
- **Trigger the new pipeline** from Port and check if it runs successfully.
100101

101102
<details>
102-
<summary><b>Sample minimal pipeline YAML</b></summary>
103+
<summary><b>Sample minimal pipeline YAML (click to expand)</b></summary>
103104

104105
```yaml showLineNumbers
105106
trigger: none # Disables automatic triggers on code commits.
@@ -183,15 +184,15 @@ Follow these steps in order to diagnose and fix common pipeline issues.
183184
### Checking pipeline status with API
184185
Use this API to verify pipeline configuration and status when the UI doesn't provide enough information or you need programmatic access:
185186
186-
```bash
187+
```bash showLineNumbers
187188
curl -X GET 'https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}?api-version=7.1-preview.1' \
188189
-H "Content-Type: application/json"
189190
```
190191
191192
### Manual pipeline trigger with API
192193
Use this API when testing or troubleshooting webhook issues, or when you need to trigger pipelines programmatically:
193194
194-
```bash
195+
```bash showLineNumbers
195196
curl -X POST 'https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1' \
196197
-H "Content-Type: application/json" \
197198
-d '{

‎docs/actions-and-automations/setup-backend/create-update-entity/create-update-entity.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ If you want to automatically create missing related entities, you can use the [w
172172
Here is an example JSON definition of a self-service action that creates a new entity and its related entities:
173173

174174
<details>
175-
<summary>**Example action JSON definition (click to expand)**</summary>
175+
<summary><b>Example action JSON definition (click to expand)</b></summary>
176+
176177
```json showLineNumbers
177178
{
178179
"identifier": "create_entity_a",

‎docs/actions-and-automations/setup-backend/github-workflow/auto-discovery.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
# Auto Discovery
5+
# Auto discovery
66

77
Actions auto discovery automates the process of discovering and syncing GitHub workflow actions with Port.
88

‎docs/actions-and-automations/setup-backend/github-workflow/github-workflow.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ By default, the integration will look for the workflow in the `main` branch of t
4242

4343
To use a different branch, simply pass the `ref` key in the `Configure the invocation payload` section (or `invocationMethod.workflowInputs` in the JSON object) with the desired branch name as the value:
4444

45-
```json
45+
```json showLineNumbers
4646
{
4747
"ref": "my-branch-name"
4848
}

‎docs/actions-and-automations/setup-backend/gitlab-pipeline/self-hosted.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can load multiple trigger tokens, for different groups and projects in your
4343
helm repo add port-labs https://port-labs.github.io/helm-charts
4444
```
4545

46-
:::note Ensure you have the latest charts
46+
:::info Ensure you have the latest charts
4747
If you already added this repo earlier, run `helm repo update` to retrieve
4848
the latest versions of the charts.
4949
You can then run `helm search repo port-labs` to see the charts.

‎docs/actions-and-automations/setup-backend/jenkins-pipeline/_category_.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Jenkins Pipeline",
2+
"label": "Jenkins pipeline",
33
"position": 3
44
}

‎docs/actions-and-automations/setup-backend/jenkins-pipeline/jenkins-pipeline.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ The steps shown in the image above are as follows:
1212
1. A self-service action or automation is invoked in Port.
1313
2. Port signs the action payload using SHA-1 with your Port [`clientSecret`](/build-your-software-catalog/custom-integration/api/api.md#find-your-port-credentials) value and puts it in the `x-port-signature` request header.
1414

15-
:::info Webhook security
16-
Verifying the webhook request using the request headers provides the following benefits:
15+
Validating the webhook request using the request headers ensures that:
1716

18-
- Ensures that the request payload has not been tampered with.
19-
- Ensures that the sender of the message is Port.
20-
- Ensures that the received message is not a replay of an older message.
21-
:::
17+
- The request payload has not been tampered with.
18+
- The sender of the message is Port.
19+
- The received message is not a replay of an older message.
20+
21+
To learn more, refer to the [validate webhook signature](/actions-and-automations/setup-backend/webhook/signature-verification) page.
2222

2323
3. Port publishes an invoked `WEBHOOK` via a `POST` request to `https://{JENKINS_URL}/generic-webhook-trigger/invoke`
2424

@@ -91,7 +91,7 @@ Here is an example of the required configuration:
9191
<img src="/img/self-service-actions/setup-backend/jenkins-pipeline/validate-webhook.png" width="100%" border='1px' />
9292
<br/><br/>
9393

94-
:::info Important
94+
:::info IP and HMAC configuration
9595

9696
- The IP field should be set to one of our hosted outbound WEBHOOK Gateway addresses: `44.221.30.248`, `44.193.148.179`, `34.197.132.205`, `3.251.12.205`, `34.252.219.131` or `54.75.236.107`.
9797
- For more information about Port's outbound calls, check out Port's [actions security](/actions-and-automations/create-self-service-experiences/security/security.md) page.

0 commit comments

Comments
 (0)
0