Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
e5807da
Initial version of github team example
melodyogonna Jul 14, 2025
ed3e5ed
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 14, 2025
fefde53
Remove repo team mapping for now
melodyogonna Jul 14, 2025
ad1ff4e
Add folder example as a monorepo
melodyogonna Jul 14, 2025
7ed4cc9
Add mapping for users and admins
melodyogonna Jul 14, 2025
2995ead
Update required permissions
melodyogonna Jul 14, 2025
115e42c
Use 'last' parameter to extract folder name
melodyogonna Jul 14, 2025
aab10c4
Update documentation, add issues example
melodyogonna Jul 14, 2025
b625d55
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 15, 2025
d620dcb
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 16, 2025
8606242
Add examples for mapping team and team members
melodyogonna Jul 16, 2025
58b0831
Remove unnecessary docs
melodyogonna Jul 17, 2025
816e623
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Jul 17, 2025
27956bb
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 17, 2025
6bfb69a
Remove repository admins for now
melodyogonna Jul 17, 2025
6469908
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 17, 2025
cee462f
Add state to issue example
melodyogonna Jul 22, 2025
43cdef4
Merge branch 'PORT-14552-document-github-ocean' of github.com:port-la…
melodyogonna Jul 22, 2025
7b9b69d
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Jul 31, 2025
4e9b6d7
Add repository admins and collaborators
melodyogonna Aug 4, 2025
5f98798
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Aug 4, 2025
6b97dee
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Aug 12, 2025
a1d2f92
Add click to expand and bolder summary to code blocks
melodyogonna Aug 12, 2025
9040fcd
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Aug 18, 2025
182b94e
Improve heading consistency in examples file
melodyogonna Aug 18, 2025
41bdbb4
Add github collaborator example
melodyogonna Aug 18, 2025
e541af8
Update collaborator events
melodyogonna Aug 18, 2025
693e51d
Improve consistency with contributing.md
melodyogonna Aug 18, 2025
4bad248
Update tone use
melodyogonna Aug 18, 2025
f80af2b
Add necessary organization permission for syncing external identities
melodyogonna Aug 20, 2025
4a059e7
Fix collaborator mappings
melodyogonna Aug 20, 2025
d9e5cda
Fix tip
melodyogonna Aug 20, 2025
e00bae5
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Aug 20, 2025
44a2fbb
Improve formatting consistency
melodyogonna Aug 20, 2025
4d4f048
fix "Blueprint" and "blueprint" inconsistency
melodyogonna Aug 20, 2025
47e3681
Remove extra line breaks in collaborator
melodyogonna Aug 21, 2025
9818567
Make team members more consistent
melodyogonna Aug 21, 2025
5da4759
Merge branch 'main' of github.com:port-labs/port-docs into PORT-14552…
melodyogonna Aug 21, 2025
0cc3687
Merge branch 'main' into PORT-14552-github-team-user-folder-docs
sivanel97 Aug 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
- [`repository`](https://docs.github.com/en/rest/repos/repos#get-a-repository)
- [`pull-request`](https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request)
- [`file`](/build-your-software-catalog/sync-data-to-catalog/git/github/#ingest-files-from-your-repositories)
- [`issue`](https://docs.github.com/en/rest/issues/issues#get-an-issue)
- [`folder`](https://docs.github.com/en/rest/git/trees#get-a-tree)
- [`user`](https://docs.github.com/en/rest/users/users#get-a-user)
- [`team`](https://docs.github.com/en/rest/teams/teams#get-a-team-by-name)
- [`workflow`](https://docs.github.com/en/rest/actions/workflows#get-a-workflow)
- [`workflow-run`](https://docs.github.com/en/rest/actions/workflow-runs#get-a-workflow-run)
- [`dependabot-alert`](https://docs.github.com/en/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<details>

<summary><b> Port port-app-config.yml (click to expand)</b></summary>
<summary><b>Port port-app-config.yml (click to expand)</b></summary>

```yaml showLineNumbers
resources:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<details>
<summary><b>Deployment blueprint (click to expand) </b></summary>
<summary><b>Deployment blueprint (click to expand)</b></summary>

```json showLineNumbers
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<details>
<summary>File Blueprint </summary>
<summary><b>File Blueprint (click to expand)</b></summary>

```yaml showLineNumbers
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<details>
<summary>Package blueprint</summary>
<summary><b>Package blueprint (click to expand)</b></summary>

```json showLineNumbers
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<details>
<summary>Port app config </summary>
<summary><b>Port app config (click to expand)</b></summary>

```yaml showLineNumbers
deleteDependentEntities: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<details>

<summary>Port config YAML</summary>
<summary><b>Port config YAML (click to expand)</b></summary>

```yaml showLineNumbers
- kind: file
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<details>
<summary><b>Issue blueprint (click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "githubIssue",
"title": "Issue",
"icon": "Github",
"schema": {
"properties": {
"creator": {
"title": "Creator",
"type": "string"
},
"assignees": {
"title": "Assignees",
"type": "array"
},
"labels": {
"title": "Labels",
"type": "array"
},
"status": {
"title": "Status",
"type": "string",
"enum": ["open", "closed"],
"enumColors": {
"open": "green",
"closed": "purple"
}
},
"createdAt": {
"title": "Created At",
"type": "string",
"format": "date-time"
},
"closedAt": {
"title": "Closed At",
"type": "string",
"format": "date-time"
},
"updatedAt": {
"title": "Updated At",
"type": "string",
"format": "date-time"
},
"description": {
"title": "Description",
"type": "string",
"format": "markdown"
},
"issueNumber": {
"title": "Issue Number",
"type": "number"
},
"link": {
"title": "Link",
"type": "string",
"format": "url"
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"relations": {
"repository": {
"target": "githubRepository",
"required": true,
"many": false
}
}
}
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<details>

<summary><b>Port port-app-config.yml (click to expand)</b></summary>

```yaml showLineNumbers
resources:
- kind: repository
selector:
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
port:
entity:
mappings:
identifier: ".name" # The Entity identifier will be the repository name.
title: ".name"
blueprint: '"githubRepository"'
properties:
readme: file://README.md
url: .html_url
defaultBranch: .default_branch
- kind: issue
selector:
query: ".pull_request == null" # JQ boolean query. If evaluated to false - skip syncing the object.
state: "closed"
port:
entity:
mappings:
identifier: ".__repository + (.id|tostring)"
title: ".title"
blueprint: '"githubIssue"'
properties:
creator: ".user.login"
assignees: "[.assignees[].login]"
labels: "[.labels[].name]"
status: ".state"
createdAt: ".created_at"
closedAt: ".closed_at"
updatedAt: ".updated_at"
description: ".body"
issueNumber: ".number"
link: ".html_url"
relations:
repository: ".__repository"
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<details>

<summary><b>Port port-app-config.yml (click to expand)</b></summary>

```yaml showLineNumbers
resources:
- kind: folder
selector:
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
folders: # Specify the repositories and folders to include under this relative path.
- path: apps/* # Relative path to the folders within the repositories.
repos: # List of repositories to include folders from.
- name: backend-service
branch: main
- name: frontend-service # if you don't specify a branch, we'll use the repository's default branch
port:
entity:
mappings:
identifier: .folder.path | split("/") | last
title: .folder.path | split("/") | last
blueprint: '"githubRepository"'
properties:
url: .__repository.html_url + "/tree/" + .__repository.default_branch + "/" + .folder.path
readme: file://README.md
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<details>
<summary><b>Repository blueprint (click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "githubRepository",
"title": "Repository",
"icon": "Microservice",
"schema": {
"properties": {
"readme": {
"title": "README",
"type": "string",
"format": "markdown"
},
"url": {
"title": "Repository URL",
"type": "string",
"format": "url"
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"aggregationProperties": {},
"relations": {
"admins": {
"title": "Admins",
"target": "githubUser",
"required": false,
"many": true
}
}
}
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<details>

<summary><b> Port port-app-config.yml (click to expand)</b></summary>

```yaml showLineNumbers
createMissingRelatedEntities: true
resources:
- kind: repository
selector:
query: "true"
include: "collaborators"
port:
entity:
mappings:
identifier: .name
title: .name
blueprint: '"githubRepository"'
properties:
readme: file://README.md
url: .html_url
defaultBranch: .default_branch
relations:
admins: "[.__collaborators[] | select(.is_admin == true) | .login]"
- kind: user
selector:
query: "true"
port:
entity:
mappings:
identifier: .login
title: if (.name != "" and .name) then .name else .login end
blueprint: '"githubUser"'
relations:
user: .email
- kind: user
selector:
query: "true"
port:
entity:
mappings:
identifier: .email
title: .email
blueprint: '"user"'
properties:
email: .email
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<details>
<summary><b>Github Users blueprint (click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "githubUser",
"title": "Github User",
"icon": "Microservice",
"schema": {
"properties": {
"email": {
"title": "Email",
"type": "string"
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"aggregationProperties": {},
"relations": {
"user": {
"title": "User",
"target": "user",
"required": false,
"many": false
}
}
}
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<details>
<summary><b>Users blueprint (click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "user",
"title": "user",
"icon": "Microservice",
"schema": {
"properties": {
"email":{
"title":"Email",
"type": "string"
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"aggregationProperties": {},
"relations": {}
}
```

</details>
Loading