-
Notifications
You must be signed in to change notification settings - Fork 60
Added documenation for branch support in azure devops #2903
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
703b8e5
Added documenation for branch support in azure devops
dev-habib-nuhu 654d0ef
Enhance summary for Iteration entity section in Azure DevOps document…
dev-habib-nuhu e104f73
Merge branch 'main' into PORT-16589
mk-armah c092121
Merge branch 'main' into PORT-16589
dev-habib-nuhu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
...-data-to-catalog/git/azure-devops/_azuredevops_exporter_supported_resources.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1082,8 +1082,46 @@ Here is an example of the payload structure from Azure DevOps: | |
|
||
</details> | ||
|
||
<details> | ||
<summary><b>Branch response data (click to expand)</b></summary> | ||
|
||
```json showLineNumbers | ||
{ | ||
"name": "refs/heads/feature/new-feature", | ||
"objectId": "ffe9cba521f00d7f60e322845072238635edb451", | ||
"creator": { | ||
"displayName": "Normal Paulk", | ||
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9", | ||
"_links": { | ||
"avatar": { | ||
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5" | ||
} | ||
}, | ||
"id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9", | ||
"uniqueName": "[email protected]", | ||
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9", | ||
"descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5" | ||
}, | ||
"url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2Fnew-feature", | ||
"__repository": { | ||
"id": "d3d1760b-311c-4175-a726-20dfc6a7f885", | ||
"name": "my-repository", | ||
"url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885", | ||
"webUrl": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_git/my-repository", | ||
"project": { | ||
"id": "7484f783-66a3-4f27-b7cd-6b08b0b077ed", | ||
"name": "My Project", | ||
"url": "https://dev.azure.com/fabrikam/_apis/projects/7484f783-66a3-4f27-b7cd-6b08b0b077ed", | ||
"state": "wellFormed", | ||
"revision": 12, | ||
"visibility": "public", | ||
"lastUpdateTime": "2025-05-04T09:34:21.397Z" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
### Mapping Result | ||
|
||
|
@@ -1281,7 +1319,7 @@ The combination of the sample payload and the Ocean configuration generates the | |
|
||
|
||
<details> | ||
<summary> Iteration entity in Port </summary> | ||
<summary><b> Iteration entity in Port (Click to expand)</b></summary> | ||
|
||
```json showLineNumbers | ||
{ | ||
|
@@ -1301,8 +1339,26 @@ The combination of the sample payload and the Ocean configuration generates the | |
|
||
</details> | ||
|
||
<details> | ||
<summary><b>Branch entity in Port (Click to expand)</b></summary> | ||
|
||
```json showLineNumbers | ||
{ | ||
"identifier": "7b3d6f8480e87f728ebce5378322c6a77d3fv19d", | ||
"title": "refs/heads/feature/new-feature", | ||
"blueprint": "branch", | ||
"properties": { | ||
"repositoryName": "my-repository", | ||
"projectName": "My Project", | ||
"link": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_git/my-repository?version=GBrefs/heads/feature/new-feature" | ||
}, | ||
"relations": { | ||
"repository": "myproject/my-repository" | ||
} | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
## Relevant Guides | ||
For relevant guides and examples, see the [guides section](https://docs.port.io/guides?tags=AzureDevops). | ||
|
47 changes: 47 additions & 0 deletions
47
.../azure-devops/example-branch/_azuredevops_exporter_example_branch_blueprint.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
<details> | ||
<summary><b>Branch blueprint (click to expand)</b></summary> | ||
|
||
```json showLineNumbers | ||
{ | ||
"identifier": "branch", | ||
"title": "Branch", | ||
"icon": "AzureDevops", | ||
"schema": { | ||
"properties": { | ||
"repositoryName": { | ||
"title": "Repository Name", | ||
"type": "string", | ||
"icon": "AzureDevops", | ||
"description": "The name of the repository that contains this branch" | ||
}, | ||
"projectName": { | ||
"title": "Project Name", | ||
"type": "string", | ||
"icon": "AzureDevops", | ||
"description": "The name of the project that contains this branch" | ||
}, | ||
"link": { | ||
"title": "Link", | ||
"type": "string", | ||
"format": "url", | ||
"icon": "Link", | ||
"description": "Link to the branch in Azure DevOps" | ||
} | ||
}, | ||
"required": [] | ||
}, | ||
"mirrorProperties": {}, | ||
"calculationProperties": {}, | ||
"aggregationProperties": {}, | ||
"relations": { | ||
"repository": { | ||
"title": "Repository", | ||
"target": "service", | ||
"required": false, | ||
"many": false | ||
} | ||
} | ||
} | ||
``` | ||
|
||
</details> |
43 changes: 43 additions & 0 deletions
43
...-devops/example-branch/_azuredevops_exporter_example_branch_port_app_config.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<details> | ||
<summary><b>Integration mapping (click to expand)</b></summary> | ||
|
||
```yaml showLineNumbers | ||
resources: | ||
- kind: repository | ||
selector: | ||
query: 'true' | ||
port: | ||
entity: | ||
mappings: | ||
identifier: >- | ||
"\(.project.name | ascii_downcase | gsub("[ ();]"; ""))/\(.name | ascii_downcase | gsub("[ ();]"; ""))" | ||
title: .name | ||
blueprint: '"service"' | ||
properties: | ||
url: .remoteUrl | ||
readme: file://README.md | ||
id: .id | ||
last_activity: .project.lastUpdateTime | ||
relations: | ||
project: .project.id | gsub(" "; "") | ||
- kind: branch | ||
selector: | ||
query: 'true' | ||
port: | ||
entity: | ||
mappings: | ||
identifier: .objectId | ||
title: .name | ||
blueprint: '"branch"' | ||
properties: | ||
repositoryName: .__repository.name | ||
projectName: .__repository.project.name | ||
link: .__repository.webUrl + "?version=GB" + .name | ||
relations: | ||
repository: >- | ||
"\(.__repository.project.name | ascii_downcase | gsub("[ ();]"; | ||
""))/\(.__repository.name | ascii_downcase | gsub("[ ();]"; ""))" | ||
|
||
``` | ||
|
||
</details> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.