Skip to content

Commit d13b38c

Browse files
sivanel97sivanel97
authored
Merge branch 'main' into PORTN-3437-add-action-run-catalog-guide-clarify-run-payload
2 parents b1db153 + 1098f12 commit d13b38c

26 files changed

+805
-14
lines changed

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/_github_exporter_supported_resources.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
- [`repository`](https://docs.github.com/en/rest/repos/repos#get-a-repository)
22
- [`pull-request`](https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request)
33
- [`file`](/build-your-software-catalog/sync-data-to-catalog/git/github/#ingest-files-from-your-repositories)
4+
- [`issue`](https://docs.github.com/en/rest/issues/issues#get-an-issue)
5+
- [`folder`](https://docs.github.com/en/rest/git/trees#get-a-tree)
6+
- [`user`](https://docs.github.com/en/rest/users/users#get-a-user)
7+
- [`team`](https://docs.github.com/en/rest/teams/teams#get-a-team-by-name)
48
- [`workflow`](https://docs.github.com/en/rest/actions/workflows#get-a-workflow)
59
- [`workflow-run`](https://docs.github.com/en/rest/actions/workflow-runs#get-a-workflow-run)
610
- [`dependabot-alert`](https://docs.github.com/en/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository)

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<details>
22

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

55
```yaml showLineNumbers
66
resources:

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<details>
2-
<summary><b>Deployment blueprint (click to expand) </b></summary>
2+
<summary><b>Deployment blueprint (click to expand)</b></summary>
33

44
```json showLineNumbers
55
{

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<details>
2-
<summary>File Blueprint </summary>
2+
<summary><b>File Blueprint (click to expand)</b></summary>
33

44
```yaml showLineNumbers
55
{

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_package_blueprint.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<details>
2-
<summary>Package blueprint</summary>
2+
<summary><b>Package blueprint (click to expand)</b></summary>
33

44
```json showLineNumbers
55
{

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<details>
2-
<summary>Port app config </summary>
2+
<summary><b>Port app config (click to expand)</b></summary>
33

44
```yaml showLineNumbers
55
deleteDependentEntities: true

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_package_json_app_config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<details>
22

3-
<summary>Port config YAML</summary>
3+
<summary><b>Port config YAML (click to expand)</b></summary>
44

55
```yaml showLineNumbers
66
- kind: file

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<details>
2+
<summary><b>Issue blueprint (click to expand)</b></summary>
3+
4+
```json showLineNumbers
5+
{
6+
"identifier": "githubIssue",
7+
"title": "Issue",
8+
"icon": "Github",
9+
"schema": {
10+
"properties": {
11+
"creator": {
12+
"title": "Creator",
13+
"type": "string"
14+
},
15+
"assignees": {
16+
"title": "Assignees",
17+
"type": "array"
18+
},
19+
"labels": {
20+
"title": "Labels",
21+
"type": "array"
22+
},
23+
"status": {
24+
"title": "Status",
25+
"type": "string",
26+
"enum": ["open", "closed"],
27+
"enumColors": {
28+
"open": "green",
29+
"closed": "purple"
30+
}
31+
},
32+
"createdAt": {
33+
"title": "Created At",
34+
"type": "string",
35+
"format": "date-time"
36+
},
37+
"closedAt": {
38+
"title": "Closed At",
39+
"type": "string",
40+
"format": "date-time"
41+
},
42+
"updatedAt": {
43+
"title": "Updated At",
44+
"type": "string",
45+
"format": "date-time"
46+
},
47+
"description": {
48+
"title": "Description",
49+
"type": "string",
50+
"format": "markdown"
51+
},
52+
"issueNumber": {
53+
"title": "Issue Number",
54+
"type": "number"
55+
},
56+
"link": {
57+
"title": "Link",
58+
"type": "string",
59+
"format": "url"
60+
}
61+
},
62+
"required": []
63+
},
64+
"mirrorProperties": {},
65+
"calculationProperties": {},
66+
"relations": {
67+
"repository": {
68+
"target": "githubRepository",
69+
"required": true,
70+
"many": false
71+
}
72+
}
73+
}
74+
```
75+
76+
</details>

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<details>
2+
3+
<summary><b>Port port-app-config.yml (click to expand)</b></summary>
4+
5+
```yaml showLineNumbers
6+
resources:
7+
- kind: repository
8+
selector:
9+
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
10+
port:
11+
entity:
12+
mappings:
13+
identifier: ".name" # The Entity identifier will be the repository name.
14+
title: ".name"
15+
blueprint: '"githubRepository"'
16+
properties:
17+
readme: file://README.md
18+
url: .html_url
19+
defaultBranch: .default_branch
20+
- kind: issue
21+
selector:
22+
query: ".pull_request == null" # JQ boolean query. If evaluated to false - skip syncing the object.
23+
state: "closed"
24+
port:
25+
entity:
26+
mappings:
27+
identifier: ".__repository + (.id|tostring)"
28+
title: ".title"
29+
blueprint: '"githubIssue"'
30+
properties:
31+
creator: ".user.login"
32+
assignees: "[.assignees[].login]"
33+
labels: "[.labels[].name]"
34+
status: ".state"
35+
createdAt: ".created_at"
36+
closedAt: ".closed_at"
37+
updatedAt: ".updated_at"
38+
description: ".body"
39+
issueNumber: ".number"
40+
link: ".html_url"
41+
relations:
42+
repository: ".__repository"
43+
```
44+
45+
</details>

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<details>
2+
3+
<summary><b>Port port-app-config.yml (click to expand)</b></summary>
4+
5+
```yaml showLineNumbers
6+
resources:
7+
- kind: folder
8+
selector:
9+
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
10+
folders: # Specify the repositories and folders to include under this relative path.
11+
- path: apps/* # Relative path to the folders within the repositories.
12+
repos: # List of repositories to include folders from.
13+
- name: backend-service
14+
branch: main
15+
- name: frontend-service # if you don't specify a branch, we'll use the repository's default branch
16+
port:
17+
entity:
18+
mappings:
19+
identifier: .folder.path | split("/") | last
20+
title: .folder.path | split("/") | last
21+
blueprint: '"githubRepository"'
22+
properties:
23+
url: .__repository.html_url + "/tree/" + .__repository.default_branch + "/" + .folder.path
24+
readme: file://README.md
25+
```
26+
27+
</details>

0 commit comments

Comments
 (0)