From e5807da3f1192a7728a13a131c7a9f6c35996d0c Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 11:03:48 +0100 Subject: [PATCH 01/25] Initial version of github team example --- ...pository_with_teams_relation_blueprint.mdx | 42 +++++++++++++++++++ .../_github_export_example_team_blueprint.mdx | 42 +++++++++++++++++++ ..._repository_with_teams_port_app_config.mdx | 42 +++++++++++++++++++ 3 files changed, 126 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx new file mode 100644 index 0000000000..bc086d42a2 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx @@ -0,0 +1,42 @@ +
+Repository blueprint + +```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" + }, + "defaultBranch": { + "title": "Default Branch", + "type": "string" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "githubTeams": { + "title": "GitHub Teams", + "target": "githubTeam", + "required": false, + "many": true + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx new file mode 100644 index 0000000000..e0842f0f91 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx @@ -0,0 +1,42 @@ +
+Team blueprint + +```json showLineNumbers +{ + "identifier": "githubTeam", + "title": "GitHub Team", + "icon": "Github", + "schema": { + "properties": { + "slug": { + "title": "Slug", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + }, + "link": { + "title": "Link", + "icon": "Link", + "type": "string", + "format": "url" + }, + "permission": { + "title": "Permission", + "type": "string" + }, + "notification_setting": { + "title": "Notification Setting", + "type": "string" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "relations": {} +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx new file mode 100644 index 0000000000..3ebdfc0cc6 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -0,0 +1,42 @@ +
+ + Port port-app-config.yml + +```yaml showLineNumbers +createMissingRelatedEntities: true +resources: + - kind: team + selector: + query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + port: + entity: + mappings: + identifier: ".id | tostring" + title: .name + blueprint: '"githubTeam"' + properties: + name: .name + slug: .slug + description: .description + link: .html_url + permission: .permission + notification_setting: .notification_setting + - kind: repository + selector: + query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + teams: true # Boolean flag to indicate whether to include the repository teams. + port: + entity: + mappings: + identifier: .name + title: .name + blueprint: '"githubRepository"' + properties: + readme: file://README.md + url: .html_url + defaultBranch: .default_branch + relations: + githubTeams: "[.teams[].id | tostring]" +``` + +
From fefde5344841891d3c7f44ae9ce470359f6e938b Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 12:27:52 +0100 Subject: [PATCH 02/25] Remove repo team mapping for now --- ...pository_with_teams_relation_blueprint.mdx | 42 ------------------- .../_github_export_example_team_blueprint.mdx | 42 ------------------- ..._repository_with_teams_port_app_config.mdx | 42 ------------------- 3 files changed, 126 deletions(-) delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx deleted file mode 100644 index bc086d42a2..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx +++ /dev/null @@ -1,42 +0,0 @@ -
-Repository blueprint - -```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" - }, - "defaultBranch": { - "title": "Default Branch", - "type": "string" - } - }, - "required": [] - }, - "mirrorProperties": {}, - "calculationProperties": {}, - "aggregationProperties": {}, - "relations": { - "githubTeams": { - "title": "GitHub Teams", - "target": "githubTeam", - "required": false, - "many": true - } - } -} -``` - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx deleted file mode 100644 index e0842f0f91..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx +++ /dev/null @@ -1,42 +0,0 @@ -
-Team blueprint - -```json showLineNumbers -{ - "identifier": "githubTeam", - "title": "GitHub Team", - "icon": "Github", - "schema": { - "properties": { - "slug": { - "title": "Slug", - "type": "string" - }, - "description": { - "title": "Description", - "type": "string" - }, - "link": { - "title": "Link", - "icon": "Link", - "type": "string", - "format": "url" - }, - "permission": { - "title": "Permission", - "type": "string" - }, - "notification_setting": { - "title": "Notification Setting", - "type": "string" - } - }, - "required": [] - }, - "mirrorProperties": {}, - "calculationProperties": {}, - "relations": {} -} -``` - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx deleted file mode 100644 index 3ebdfc0cc6..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ /dev/null @@ -1,42 +0,0 @@ -
- - Port port-app-config.yml - -```yaml showLineNumbers -createMissingRelatedEntities: true -resources: - - kind: team - selector: - query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. - port: - entity: - mappings: - identifier: ".id | tostring" - title: .name - blueprint: '"githubTeam"' - properties: - name: .name - slug: .slug - description: .description - link: .html_url - permission: .permission - notification_setting: .notification_setting - - kind: repository - selector: - query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. - teams: true # Boolean flag to indicate whether to include the repository teams. - port: - entity: - mappings: - identifier: .name - title: .name - blueprint: '"githubRepository"' - properties: - readme: file://README.md - url: .html_url - defaultBranch: .default_branch - relations: - githubTeams: "[.teams[].id | tostring]" -``` - -
From ad1ff4e231849e1cc990270b093d5ecb5b6bb9ba Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 12:28:14 +0100 Subject: [PATCH 03/25] Add folder example as a monorepo --- ...orter_example_monorepo_port_app_config.mdx | 27 ++++++++++++++++ .../git/github-ocean/examples/examples.md | 32 +++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx new file mode 100644 index 0000000000..2252ef843a --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -0,0 +1,27 @@ +
+ + Port port-app-config.yml + +```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("/")[-1] + title: .folder.path | split("/")[-1] + blueprint: '"githubRepository"' + properties: + url: .__repository.html_url + "/tree/" + .__repository.default_branch + "/" + .folder.path + readme: file://README.md +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 7065397137..1b2e7b0175 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -10,6 +10,7 @@ import GitHubResources from '../\_github_exporter_supported_resources.mdx' import PackageBlueprint from './example-file-kind/\_example_package_blueprint.mdx' import PackageAppConfig from './example-file-kind/\_package_json_app_config.mdx' +import PortMonoRepoAppConfig from './example-monorepo/\_github_exporter_example_monorepo_port_app_config.mdx' # Resource mapping examples @@ -61,6 +62,37 @@ The following example demonstrates ingestion of dependencies from a `package.jso The example will parse the `package.json` file in your repository and extract the dependencies into Port entities. For more information about ingesting files and file contents, click [here](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/#ingest-files-from-your-repositories). +## Map repositories and monorepos + +In the following example you will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. you may use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + +To retrieve the root folders of your monorepo, you can use this following syntax in your `port-app-config.yml`: + +```yaml +- 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: "*" # Relative path to the folders within the repositories. + repos: # List of repositories to include folders from. + - name: backend-service + - name: frontend-service +``` + + +:::tip learn more + +- Refer to the [setup](/build-your-software-catalog/sync-data-to-catalog/git/github/github.md#setup) section to learn more about the `port-app-config.yml` setup process. +- We leverage [JQ JSON processor](https://stedolan.github.io/jq/manual/) to map and transform GitHub objects to Port Entities. +- Click [Here](https://docs.github.com/en/rest/repos/repos#get-a-repository) for the GitHub repository object structure. +- Click [Here](https://docs.github.com/en/rest/git/trees#get-a-tree) for the GitHub folder object structure. + +::: ## Map supported resources From 7ed4cc93130f117271457d4b310e5b28e010ba96 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 13:05:10 +0100 Subject: [PATCH 04/25] Add mapping for users and admins --- ...ository_with_admins_relation_blueprint.mdx | 38 +++++++++++++++ ...r_example_admins_users_port_app_config.mdx | 48 +++++++++++++++++++ ...xporter_example_github_users_blueprint.mdx | 32 +++++++++++++ ...ithub_exporter_example_users_blueprint.mdx | 25 ++++++++++ .../git/github-ocean/examples/examples.md | 31 ++++++++++++ 5 files changed, 174 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx new file mode 100644 index 0000000000..f9afb4ac0e --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx @@ -0,0 +1,38 @@ +
+Repository blueprint + +```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 + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx new file mode 100644 index 0000000000..fdd17de514 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -0,0 +1,48 @@ +
+ + Port port-app-config.yml + +```yaml showLineNumbers +createMissingRelatedEntities: true +resources: + - kind: repository + selector: + query: "true" + collaborators: true + 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"' + relations: + user: .email +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx new file mode 100644 index 0000000000..a1e80f8e97 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx @@ -0,0 +1,32 @@ +
+Github Users blueprint + +```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 + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx new file mode 100644 index 0000000000..d2b5bc65be --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx @@ -0,0 +1,25 @@ +
+Users blueprint + +```json showLineNumbers +{ + "identifier": "user", + "title": "user", + "icon": "Microservice", + "schema": { + "properties": { + "email":{ + "title":"Email", + "type": "string" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": {} +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 1b2e7b0175..d53f99784c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -7,6 +7,11 @@ import PRBlueprint from './\_github_exporter_example_pull_request_blueprint.mdx' import PortAppConfig from './\_github_exporter_example_port_app_config.mdx' import GitHubResources from '../\_github_exporter_supported_resources.mdx' +import UsersBlueprint from './example-repository-admins/\_github_exporter_example_users_blueprint.mdx' +import GithubUsersBlueprint from './example-repository-admins/\_github_exporter_example_github_users_blueprint.mdx' +import RepositoryAdminBlueprint from './example-repository-admins/\_github_export_example_repository_with_admins_relation_blueprint.mdx' +import RepositoryAdminAppConfig from './example-repository-admins/\_github_exporter_example_admins_users_port_app_config.mdx' + import PackageBlueprint from './example-file-kind/\_example_package_blueprint.mdx' import PackageAppConfig from './example-file-kind/\_package_json_app_config.mdx' @@ -52,6 +57,32 @@ The `repositoryType` parameter filters which repositories are ingested. It corre After creating the blueprints and committing the `port-app-config.yml` file to your `.github-private` repository (for global configuration), or to any specific repositories (for per-repo configuration), you will see new entities in Port matching your repositories alongside their README.md file contents and pull requests. (Remember that the `port-app-config.yml` file has to be in the **default branch** of the repository to take effect). +## Map repositories, repository admins and users + +In the following example you will ingest your GitHub repositories, their admins and related users to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + + + +

Supported GitHub user types

+ +As Github has strict privacy policies, the GitHub API will only return emails in the following cases: + +1. The user has a public email address +2. Your organization is working with a GitHub Enterprise Cloud plan, and the user has an SAML SSO identity configured inside the GitHub organization. + +In other cases, the GitHub API will return a `null` value for the user's email. + +:::tip User supported fields +For the `user` kind, only the following fields are supported: `.login`, and `.email`. +Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available. +::: + ## Map files and file contents The following example demonstrates ingestion of dependencies from a `package.json` file in your repository into Port: From 2995ead3e27869d77eee5908ebe59287963c0d4e Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 13:09:55 +0100 Subject: [PATCH 05/25] Update required permissions --- .../git/github-ocean/installation/installation.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx index d2a78c5fc2..6095a5ee2a 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx @@ -42,11 +42,13 @@ To create a personal access token see Github's [managing your personal access to These are the necessary permissions if you're creating a fine-grained PAT. **Repository permissions:** - - **Content**: Readonly + - **Content**: Readonly (For reading files) - **Metadata**: Readonly - **Pull Requests**: Readonly + - **Administration:** Readonly (for syncing github teams and collaborators) **Organization permissions:** + - **Members**: Readonly(for syncing users) - **Webhooks**: Read and Write (for managing webhook) From 115e42ccd0042b2bbf08908548d77ef1753ef922 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 13:23:39 +0100 Subject: [PATCH 06/25] Use 'last' parameter to extract folder name --- .../_github_exporter_example_monorepo_port_app_config.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx index 2252ef843a..d022a9cf43 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -16,8 +16,8 @@ resources: port: entity: mappings: - identifier: .folder.path | split("/")[-1] - title: .folder.path | split("/")[-1] + identifier: .folder.path | split("/") | last + title: .folder.path | split("/") | last blueprint: '"githubRepository"' properties: url: .__repository.html_url + "/tree/" + .__repository.default_branch + "/" + .folder.path From aab10c4c41c1c401924e0c6aa06a92e5fc731547 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 14 Jul 2025 14:30:02 +0100 Subject: [PATCH 07/25] Update documentation, add issues example --- .../_github_exporter_supported_resources.mdx | 5 +- .../_git_exporter_example_issue_blueprint.mdx | 76 +++++++++++++++++++ ...exporter_example_issue_port_app_config.mdx | 44 +++++++++++ .../git/github-ocean/examples/examples.md | 24 ++++++ .../installation/installation.mdx | 1 + .../ocean-saas-specifics/live-events.jsx | 31 +++++++- 6 files changed, 179 insertions(+), 2 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/_github_exporter_supported_resources.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/_github_exporter_supported_resources.mdx index a88e7eb1ce..556ffee3b2 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/_github_exporter_supported_resources.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/_github_exporter_supported_resources.mdx @@ -1,4 +1,7 @@ - [`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) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx new file mode 100644 index 0000000000..e75582246d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx @@ -0,0 +1,76 @@ +
+Issue blueprint + +```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 + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx new file mode 100644 index 0000000000..5f0268f7da --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -0,0 +1,44 @@ +
+ + Port port-app-config.yml + +```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. + 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" +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index d53f99784c..2ad82e22a7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -12,6 +12,9 @@ import GithubUsersBlueprint from './example-repository-admins/\_github_exporter_ import RepositoryAdminBlueprint from './example-repository-admins/\_github_export_example_repository_with_admins_relation_blueprint.mdx' import RepositoryAdminAppConfig from './example-repository-admins/\_github_exporter_example_admins_users_port_app_config.mdx' +import IssueBlueprint from './example-issue/\_git_exporter_example_issue_blueprint.mdx' +import PortIssueAppConfig from './example-issue/\_github_exporter_example_issue_port_app_config.mdx' + import PackageBlueprint from './example-file-kind/\_example_package_blueprint.mdx' import PackageAppConfig from './example-file-kind/\_package_json_app_config.mdx' @@ -83,6 +86,27 @@ For the `user` kind, only the following fields are supported: `.login`, and `.em Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available. ::: +## Map repositories and issues + +In the following example you will ingest your GitHub repositories and their issues to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + +:::tip learn more + +- Refer to the [setup](/build-your-software-catalog/sync-data-to-catalog/git/github/github.md#setup) section to learn more about the `port-app-config.yml` setup process. +- We leverage [JQ JSON processor](https://stedolan.github.io/jq/manual/) to map and transform GitHub objects to Port Entities. +- Click [Here](https://docs.github.com/en/rest/repos/repos#get-a-repository) for the GitHub repository object structure. +- Click [Here](https://docs.github.com/en/rest/issues/issues#get-an-issue) for the GitHub issue object structure. + +::: + +After creating the blueprints and committing the `port-app-config.yml` file to your `.github-private` repository (for global configuration), or to any specific repositories (for per-repo configuration), you will see new entities in Port matching your repositories alongside their issues. (Remember that the `port-app-config.yml` file has to be in the **default branch** of the repository to take effect). + ## Map files and file contents The following example demonstrates ingestion of dependencies from a `package.json` file in your repository into Port: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx index 6095a5ee2a..f00325d275 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx @@ -45,6 +45,7 @@ To create a personal access token see Github's [managing your personal access to - **Content**: Readonly (For reading files) - **Metadata**: Readonly - **Pull Requests**: Readonly + - **Issues**: Readonly - **Administration:** Readonly (for syncing github teams and collaborators) **Organization permissions:** diff --git a/src/components/ocean-saas-specifics/live-events.jsx b/src/components/ocean-saas-specifics/live-events.jsx index ab549fae74..340217767e 100644 --- a/src/components/ocean-saas-specifics/live-events.jsx +++ b/src/components/ocean-saas-specifics/live-events.jsx @@ -204,7 +204,36 @@ export const liveEvents = { \n - unassigned \ \n - review_request_removed \ \n - closed \ - \n\n **push:** ", + \n\n **push:** \ + \n\n **issues:** \ + \n - assigned \ + \n - closed \ + \n - demilestoned \ + \n - edited \ + \n - labeled \ + \n - locked \ + \n - milestoned \ + \n - opened \ + \n - pinned \ + \n - reopened \ + \n - transferred \ + \n - typed \ + \n - unassigned \ + \n - unlabeled \ + \n - unlocked \ + \n - unpinned \ + \n - untyped \ + \n - deleted \ + \n\n **team:** \ + \n - created \ + \n - edited \ + \n - deleted \ + \n\n **membership:** \ + \n - added \ + \n - removed \ + \n\n **organization:** \ + \n - member_added \ + \n - member_removed", }; export const OceanSaasLiveEventsTriggersOAuth = ({ id, isOAuth = false }) => { From 8606242ec8d8356aea7241b96653ec08a7becc10 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 17:47:07 +0100 Subject: [PATCH 08/25] Add examples for mapping team and team members --- .../_github_exporter_team_blueprint.mdx | 53 +++++++++++++++++++ ..._github_exporter_team_member_blueprint.mdx | 24 +++++++++ .../_github_team_member_port_app_config.mdx | 39 ++++++++++++++ .../git/github-ocean/examples/examples.md | 10 ++++ 4 files changed, 126 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx new file mode 100644 index 0000000000..43de7e9cd4 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx @@ -0,0 +1,53 @@ +
+ Team Blueprint + +```json showLineNumbers +{ + "identifier": "githubTeam", + "title": "GitHub Team", + "icon": "Github", + "schema": { + "properties": { + "slug": { + "title": "Slug", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + }, + "link": { + "title": "Link", + "icon": "Link", + "type": "string", + "format": "url" + }, + "permission": { + "title": "Permission", + "type": "string" + }, + "notification_setting": { + "title": "Notification Setting", + "type": "string" + }, + "members": { + "title": "Members", + "type": "array" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "team_member": { + "title": "teamMember", + "target": "githubTeamMember", + "required": false, + "many": true + } + } +} +``` +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx new file mode 100644 index 0000000000..708a428ad2 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -0,0 +1,24 @@ +
+ Team Member Blueprint + +```json showLineNumbers +{ + "identifier": "githubTeamMember", + "title": "Team Member", + "icon": "Github", + "schema": { + "properties": { + "all": { + "type": "object", + "title": "all" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": {} +} +``` +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx new file mode 100644 index 0000000000..ee0c7f04c7 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx @@ -0,0 +1,39 @@ +
+ Port port-app-config.yaml + +```yaml showLineNumbers + - kind: team + selector: + query: 'true' + members: true + port: + entity: + mappings: + identifier: .id | tostring + title: .name + blueprint: '"githubTeam"' + properties: + slug: .slug + description: .description + link: .url + permission: .permission + notification_setting: .notificationSetting + relations: + team_member: '[.members.nodes[].login]' + - kind: team + selector: + query: 'true' + members: true + port: + itemsToParse: .members.nodes + entity: + mappings: + identifier: .login + title: .login + blueprint: '"githubTeamMember"' + properties: + all: . + + +``` +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 037e244987..6aa36b0039 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -18,6 +18,10 @@ import PortIssueAppConfig from './example-issue/\_github_exporter_example_issue_ import PackageBlueprint from './example-file-kind/\_example_package_blueprint.mdx' import PackageAppConfig from './example-file-kind/\_package_json_app_config.mdx' +import TeamBlueprint from './example-team-members/\_github_exporter_team_blueprint.mdx' +import TeamMemberBlueprint from './example-team-members/\_github_exporter_team_member_blueprint.mdx' +import TeamMemberConfig from './example-team-members/\_github_team_member_port_app_config.mdx' + import PortMonoRepoAppConfig from './example-monorepo/\_github_exporter_example_monorepo_port_app_config.mdx' # Resource mapping examples @@ -148,6 +152,12 @@ To retrieve the root folders of your monorepo, you can use this following syntax ::: +## Map team and team member +The following show how you can map team and team members using the "members" selector. + + + + ## Map supported resources From 58b083124de813c461f5358d97a0111a58ce08b9 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Thu, 17 Jul 2025 11:12:01 +0100 Subject: [PATCH 09/25] Remove unnecessary docs --- .../sync-data-to-catalog/git/github-ocean/examples/examples.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 6aa36b0039..c18cd9ec3b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -108,8 +108,6 @@ In the following example you will ingest your GitHub repositories and their issu ::: -After creating the blueprints and committing the `port-app-config.yml` file to your `.github-private` repository (for global configuration), or to any specific repositories (for per-repo configuration), you will see new entities in Port matching your repositories alongside their issues. (Remember that the `port-app-config.yml` file has to be in the **default branch** of the repository to take effect). - ## Map files and file contents The following example demonstrates ingestion of dependencies from a `package.json` file in your repository into Port: From 6bfb69a0c6e738821b31c2aa999db8886ebbc77d Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Thu, 17 Jul 2025 11:57:02 +0100 Subject: [PATCH 10/25] Remove repository admins for now --- .../git/github-ocean/examples/examples.md | 26 ------------------- 1 file changed, 26 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index c18cd9ec3b..03c69bcaa8 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -63,32 +63,6 @@ The `repositoryType` parameter filters which repositories are ingested. It corre After creating the blueprints and committing the `port-app-config.yml` file to your `.github-private` repository (for global configuration), or to any specific repositories (for per-repo configuration), you will see new entities in Port matching your repositories alongside their README.md file contents and pull requests. (Remember that the `port-app-config.yml` file has to be in the **default branch** of the repository to take effect). -## Map repositories, repository admins and users - -In the following example you will ingest your GitHub repositories, their admins and related users to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: - - - - - - - - - -

Supported GitHub user types

- -As Github has strict privacy policies, the GitHub API will only return emails in the following cases: - -1. The user has a public email address -2. Your organization is working with a GitHub Enterprise Cloud plan, and the user has an SAML SSO identity configured inside the GitHub organization. - -In other cases, the GitHub API will return a `null` value for the user's email. - -:::tip User supported fields -For the `user` kind, only the following fields are supported: `.login`, and `.email`. -Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available. -::: - ## Map repositories and issues In the following example you will ingest your GitHub repositories and their issues to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: From cee462fe2c3ae0521b54770b8561c8549a83550f Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Tue, 22 Jul 2025 19:45:53 +0100 Subject: [PATCH 11/25] Add state to issue example --- .../_github_exporter_example_issue_port_app_config.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx index 5f0268f7da..11f7899d03 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -20,6 +20,7 @@ resources: - kind: issue selector: query: ".pull_request == null" # JQ boolean query. If evaluated to false - skip syncing the object. + state: "closed" port: entity: mappings: From 4e9b6d7e4c5cdd30717d9454087f36a82bca7b2b Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 4 Aug 2025 08:48:39 +0100 Subject: [PATCH 12/25] Add repository admins and collaborators --- ...r_example_admins_users_port_app_config.mdx | 2 +- ...pository_with_teams_relation_blueprint.mdx | 42 ++++++++++++++++++ .../_github_export_example_team_blueprint.mdx | 42 ++++++++++++++++++ ..._repository_with_teams_port_app_config.mdx | 42 ++++++++++++++++++ .../git/github-ocean/examples/examples.md | 43 ++++++++++++++++++- 5 files changed, 169 insertions(+), 2 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx index fdd17de514..b4ee728f93 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -8,7 +8,7 @@ resources: - kind: repository selector: query: "true" - collaborators: true + include: "collaborators" port: entity: mappings: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx new file mode 100644 index 0000000000..bc086d42a2 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx @@ -0,0 +1,42 @@ +
+Repository blueprint + +```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" + }, + "defaultBranch": { + "title": "Default Branch", + "type": "string" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "githubTeams": { + "title": "GitHub Teams", + "target": "githubTeam", + "required": false, + "many": true + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx new file mode 100644 index 0000000000..e0842f0f91 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx @@ -0,0 +1,42 @@ +
+Team blueprint + +```json showLineNumbers +{ + "identifier": "githubTeam", + "title": "GitHub Team", + "icon": "Github", + "schema": { + "properties": { + "slug": { + "title": "Slug", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + }, + "link": { + "title": "Link", + "icon": "Link", + "type": "string", + "format": "url" + }, + "permission": { + "title": "Permission", + "type": "string" + }, + "notification_setting": { + "title": "Notification Setting", + "type": "string" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "relations": {} +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx new file mode 100644 index 0000000000..120501e194 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -0,0 +1,42 @@ +
+ + Port port-app-config.yml + +```yaml showLineNumbers +createMissingRelatedEntities: true +resources: + - kind: team + selector: + query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + port: + entity: + mappings: + identifier: ".id | tostring" + title: .name + blueprint: '"githubTeam"' + properties: + name: .name + slug: .slug + description: .description + link: .html_url + permission: .permission + notification_setting: .notification_setting + - kind: repository + selector: + query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + include: "team" # Boolean flag to indicate whether to include the repository teams. + port: + entity: + mappings: + identifier: .name + title: .name + blueprint: '"githubRepository"' + properties: + readme: file://README.md + url: .html_url + defaultBranch: .default_branch + relations: + githubTeams: "[.teams[].id | tostring]" +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index b367bb89c4..bb2cea4cb4 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -24,6 +24,9 @@ import TeamBlueprint from './example-team-members/\_github_exporter_team_bluepri import TeamMemberBlueprint from './example-team-members/\_github_exporter_team_member_blueprint.mdx' import TeamMemberConfig from './example-team-members/\_github_team_member_port_app_config.mdx' +import RepositoryTeamBlueprint from './example-repository-teams/\_github_export_example_repository_with_teams_relation_blueprint.mdx' +import PortRepositoryTeamMappingAppConfig from './example-repository-teams/\_github_exporter_example_repository_with_teams_port_app_config.mdx' + import PortMonoRepoAppConfig from './example-monorepo/\_github_exporter_example_monorepo_port_app_config.mdx' # Resource mapping examples @@ -121,13 +124,51 @@ To retrieve the root folders of your monorepo, you can use this following syntax ::: -## Map team and team member +## Map repositories and teams + +The following example demonstrates how to ingest your GitHub repositories and their teams to Port. +You can use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + + +## Map team and team members The following show how you can map team and team members using the "members" selector. + +## Map repositories, repository admins and users + +The following example demonstrates how to ingest your GitHub repositories, their admins and related users to Port. +You can use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + +

Supported GitHub user types

+ +As Github has strict privacy policies, the GitHub API will only return emails in the following cases: + +1. The user has a public email address +2. Your organization is working with a GitHub Enterprise Cloud plan, and the user has an SAML SSO identity configured inside the GitHub organization. + +In other cases, the GitHub API will return a `null` value for the user's email. + +:::tip User supported fields +For the `user` kind, only the following fields are supported: `.name`, `.login`, and `.email`. +Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available. +::: + ## Map supported resources The examples above show specific use cases, but Port's GitHub integration supports the ingestion of many other GitHub objects. From a1d2f924b6f1f378e510c5618a213055600c5140 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Tue, 12 Aug 2025 09:11:55 +0100 Subject: [PATCH 13/25] Add click to expand and bolder summary to code blocks --- .../examples/example-file-kind/_example_file_blueprint.mdx | 2 +- .../examples/example-file-kind/_example_package_blueprint.mdx | 2 +- .../examples/example-file-kind/_file_repo_app_config.mdx | 2 +- .../examples/example-file-kind/_package_json_app_config.mdx | 2 +- .../example-issue/_git_exporter_example_issue_blueprint.mdx | 2 +- .../_github_exporter_example_issue_port_app_config.mdx | 2 +- .../_github_exporter_example_monorepo_port_app_config.mdx | 2 +- ...export_example_repository_with_admins_relation_blueprint.mdx | 2 +- .../_github_exporter_example_admins_users_port_app_config.mdx | 2 +- .../_github_exporter_example_github_users_blueprint.mdx | 2 +- .../_github_exporter_example_users_blueprint.mdx | 2 +- ..._export_example_repository_with_teams_relation_blueprint.mdx | 2 +- .../_github_export_example_team_blueprint.mdx | 2 +- ...b_exporter_example_repository_with_teams_port_app_config.mdx | 2 +- .../example-team-members/_github_exporter_team_blueprint.mdx | 2 +- .../_github_exporter_team_member_blueprint.mdx | 2 +- .../_github_team_member_port_app_config.mdx | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx index 6b7016ef7b..72dca8da19 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx @@ -1,5 +1,5 @@
- File Blueprint + File Blueprint (click to expand) ```yaml showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_package_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_package_blueprint.mdx index ef024ed571..1fba9fda8e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_package_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_package_blueprint.mdx @@ -1,5 +1,5 @@
-Package blueprint +Package blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx index 43c11361f3..cc24964830 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx @@ -1,5 +1,5 @@
- Port app config + Port app config (click to expand) ```yaml showLineNumbers deleteDependentEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_package_json_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_package_json_app_config.mdx index 26658027e2..2784966dd5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_package_json_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_package_json_app_config.mdx @@ -1,6 +1,6 @@
-Port config YAML +Port config YAML (click to expand) ```yaml showLineNumbers - kind: file diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx index e75582246d..e190d68b2f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx @@ -1,5 +1,5 @@
-Issue blueprint +Issue blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx index 11f7899d03..4982411526 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml + Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx index d022a9cf43..083484071d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml + Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx index f9afb4ac0e..e29f09f82d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint +Repository blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx index b4ee728f93..3983c5934c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml + Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx index a1e80f8e97..3efe9b1d0e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx @@ -1,5 +1,5 @@
-Github Users blueprint +Github Users blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx index d2b5bc65be..9cc92696c3 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx @@ -1,5 +1,5 @@
-Users blueprint +Users blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx index bc086d42a2..b5a2f87313 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint +Repository blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx index e0842f0f91..d938577bc7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx @@ -1,5 +1,5 @@
-Team blueprint +Team blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx index 120501e194..e80d818f64 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml + Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx index 43de7e9cd4..75fa2374a6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx @@ -1,5 +1,5 @@
- Team Blueprint + Team Blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx index 708a428ad2..15d590892a 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -1,5 +1,5 @@
- Team Member Blueprint + Team Member Blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx index ee0c7f04c7..af68eeb205 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx @@ -1,5 +1,5 @@
- Port port-app-config.yaml + Port port-app-config.yaml (click to expand) ```yaml showLineNumbers - kind: team From 182b94eb297bc7db20de3ecd545bdb6b109ed342 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 18 Aug 2025 11:49:24 +0100 Subject: [PATCH 14/25] Improve heading consistency in examples file --- .../_github_exporter_example_issue_port_app_config.mdx | 2 +- ..._github_exporter_example_monorepo_port_app_config.mdx | 2 +- .../git/github-ocean/examples/examples.md | 9 +++++---- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx index 4982411526..8d83290f5f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx index 083484071d..d86acc7e8f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 219d642ee2..5d212cc790 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -112,7 +112,7 @@ The example will parse the `package.json` file in your repository and extract th For more information about ingesting files and file contents, click [here](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/#ingest-files-from-your-repositories). -## Map Files and Repositories +## Map files and repositories The following example demonstrates mapping files to repository. @@ -182,7 +182,8 @@ You can use the following Port blueprint definitions and `port-app-config.yml`: -## Map team and team members +## Map teams and team members + The following show how you can map team and team members using the "members" selector. @@ -205,7 +206,7 @@ You can use the following Port blueprint definitions and `port-app-config.yml`: As Github has strict privacy policies, the GitHub API will only return emails in the following cases: -1. The user has a public email address +1. The user has a public email address. 2. Your organization is working with a GitHub Enterprise Cloud plan, and the user has an SAML SSO identity configured inside the GitHub organization. In other cases, the GitHub API will return a `null` value for the user's email. @@ -216,7 +217,7 @@ Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/us ::: -## Map repositories, Dependabot Alerts, and Code scan alerts +## Map repositories, dependabot alerts, and code scan alerts The following example shows how to ingest your GitHub repositories and their alerts (Dependabot and Code scan alerts) into Port. You can use the following Port blueprint definitions and `port-app-config.yml`: From 41bdbb4c87cd654bbd9a8db46aef859da96d1a8e Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 18 Aug 2025 15:22:54 +0100 Subject: [PATCH 15/25] Add github collaborator example --- ...xporter_example_collaborator_blueprint.mdx | 51 +++++++++++++++++ ...epository_collaborator_port_app_config.mdx | 55 +++++++++++++++++++ ..._repository_with_teams_port_app_config.mdx | 2 +- .../git/github-ocean/examples/examples.md | 20 +++++-- .../github-ocean/installation/github-app.mdx | 2 + 5 files changed, 125 insertions(+), 5 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx new file mode 100644 index 0000000000..8c954a9646 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx @@ -0,0 +1,51 @@ +
+Collaborator blueprint (click to expand) + +```json showLineNumbers +{ + "identifier": "githubCollaborator", + "title": "Github Collaborator", + "icon": "Github", + "schema": { + "properties": { + "login": { + "type": "string", + "title": "Login" + }, + "url": { + "type": "string", + "title": "Url", + "format": "url" + }, + "type": { + "type": "string", + "title": "Type" + }, + "site_admin": { + "type": "boolean", + "title": "Site admin" + }, + "role": { + "type": "string", + "title": "Role" + } + }, + "required": [ + "login" + ] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "repository": { + "title": "repository", + "target": "githubRepository", + "required": true, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx new file mode 100644 index 0000000000..8c1ea31640 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx @@ -0,0 +1,55 @@ +
+ + Port port-app-config.yml (click to expand) + +```yaml showLineNumbers +createMissingRelatedEntities: true +resources: + - kind: repository + selector: + query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + port: + entity: + mappings: + identifier: .name + title: .name + blueprint: '"githubRepository"' + properties: + readme: file://README.md + url: .html_url + defaultBranch: .default_branch + + - kind: collaborator + selector: + query: "true" + port: + entity: + mappings: + identifier: .__repository + "/" + .login + title: .login + blueprint: '"githubCollaborator"' + properties: + login: .login + url: .html_url + type: .type + site_admin: .site_admin + role: .role_name + relations: + repository: .__repository + + + + + + + + + + + + + + +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx index e80d818f64..d4c35fe4c7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -24,7 +24,7 @@ resources: - kind: repository selector: query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. - include: "team" # Boolean flag to indicate whether to include the repository teams. + include: "teams" # Boolean flag to indicate whether to include the repository teams. port: entity: mappings: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 5d212cc790..dea2e5266e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -27,13 +27,17 @@ import PackageAppConfig from './example-file-kind/\_package_json_app_config.mdx' import FileBlueprint from './example-file-kind/\_example_file_blueprint.mdx' import RepoFileAppConfig from './example-file-kind/\_file_repo_app_config.mdx' -import TeamBlueprint from './example-team-members/\_github_exporter_team_blueprint.mdx' +import TeamWithMembersBlueprint from './example-team-members/\_github_exporter_team_blueprint.mdx' import TeamMemberBlueprint from './example-team-members/\_github_exporter_team_member_blueprint.mdx' import TeamMemberConfig from './example-team-members/\_github_team_member_port_app_config.mdx' +import TeamBlueprint from './example-repository-teams/\_github_export_example_team_blueprint.mdx' import RepositoryTeamBlueprint from './example-repository-teams/\_github_export_example_repository_with_teams_relation_blueprint.mdx' import PortRepositoryTeamMappingAppConfig from './example-repository-teams/\_github_exporter_example_repository_with_teams_port_app_config.mdx' +import CollaboratorBlueprint from './example-repository-collaborators/\_github_exporter_example_collaborator_blueprint.mdx' +import PortRepositoryCollaboratorAppConfig from './example-repository-collaborators/\_github_exporter_example_repository_collaborator_port_app_config.mdx' + import PortMonoRepoAppConfig from './example-monorepo/\_github_exporter_example_monorepo_port_app_config.mdx' import WorkflowBlueprint from './example-workflow-workflowrun/\_git_exporter_example_workflow_blueprint.mdx' import WorkflowRunBlueprint from './example-workflow-workflowrun/\_git_exporter_example_workflow_run_blueprint.mdx' @@ -122,7 +126,7 @@ The following example demonstrates mapping files to repository. ## Map repositories and monorepos -In the following example you will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. you may use the following Port blueprint definitions and `port-app-config.yml`: +In the following example you will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`: @@ -184,10 +188,10 @@ You can use the following Port blueprint definitions and `port-app-config.yml`: ## Map teams and team members -The following show how you can map team and team members using the "members" selector. +The following shows how you can map teams and team members using the "members" selector. - + @@ -216,6 +220,14 @@ For the `user` kind, only the following fields are supported: `.name`, `.login`, Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available. ::: +## Map repositories and collaborators + +The following example demonstrates how to ingest your GitHub repositories and their collaborators to Port. +You can use the following Port blueprint definitions and `port-app-config.yml`: + + + + ## Map repositories, dependabot alerts, and code scan alerts diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx index 338680d33e..c4c263bb32 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx @@ -46,12 +46,14 @@ This page outlines the following steps: - Checks: Readonly (for syncing `Port.yml`). - Contents: Readonly (for reading port configuration files and repository files). - Metadata: Readonly. + - Administration: Readonly (for syncing collaborators) - Pull Request: Readonly - Code scanning alerts: Readonly - Dependabot alerts: Readonly - Deployments: Readonly - Environments: Readonly - **Organization Permissions:** + - Members: Readonly (for syncing members and teams). - Webhooks: Read and Write (to allow the integration create webhook). Then select "Create GitHub App" From e541af8e327898f11c4f5eea80ae6dc67c5fa441 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 18 Aug 2025 15:28:10 +0100 Subject: [PATCH 16/25] Update collaborator events --- src/components/ocean-saas-specifics/live-events.jsx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/components/ocean-saas-specifics/live-events.jsx b/src/components/ocean-saas-specifics/live-events.jsx index 19539bdc9b..cfde343ece 100644 --- a/src/components/ocean-saas-specifics/live-events.jsx +++ b/src/components/ocean-saas-specifics/live-events.jsx @@ -224,9 +224,14 @@ export const liveEvents = { \n - created \ \n - edited \ \n - deleted \ + \n - added_to_repository \ \n\n **membership:** \ \n - added \ \n - removed \ + \n\n **member:** \ + \n - added \ + \n - edited \ + \n - removed \ \n\n **organization:** \ \n - member_added \ \n - member_removed \ From 693e51d73a7ca902dcef5c898b64533eaf05db93 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 18 Aug 2025 15:36:03 +0100 Subject: [PATCH 17/25] Improve consistency with contributing.md --- .../examples/_github_exporter_example_port_app_config.mdx | 2 +- .../_github_exporter_example_pull_request_blueprint.mdx | 2 +- .../examples/_github_exporter_example_repository_blueprint.mdx | 2 +- .../example-branch/_git_exporter_example_branch_blueprint.mdx | 2 +- .../_github_exporter_example_branch_port_app_config.mdx | 2 +- .../_github_exporter_example_deployment_blueprint.mdx | 2 +- ...ter_example_deployments_and_environments_port_app_config.mdx | 2 +- .../_github_exporter_example_environment_blueprint.mdx | 2 +- .../examples/example-file-kind/_example_file_blueprint.mdx | 2 +- .../examples/example-file-kind/_file_repo_app_config.mdx | 2 +- .../example-issue/_git_exporter_example_issue_blueprint.mdx | 2 +- .../_github_exporter_example_issue_port_app_config.mdx | 2 +- .../_github_exporter_example_monorepo_port_app_config.mdx | 2 +- ...export_example_repository_with_admins_relation_blueprint.mdx | 2 +- .../_github_exporter_example_admins_users_port_app_config.mdx | 2 +- .../_github_exporter_example_github_users_blueprint.mdx | 2 +- .../_github_exporter_example_users_blueprint.mdx | 2 +- .../_github_exporter_example_codeScan_alert_blueprint.mdx | 2 +- .../_github_exporter_example_dependabot_alert_blueprint.mdx | 2 +- ..._github_exporter_example_repo_dependabot_port_app_config.mdx | 2 +- .../_github_exporter_example_collaborator_blueprint.mdx | 2 +- ...exporter_example_repository_collaborator_port_app_config.mdx | 2 +- .../_github_exporter_example_release_blueprint.mdx | 2 +- .../_github_exporter_example_release_tag_port_app_config.mdx | 2 +- .../_github_exporter_example_tag_blueprint.mdx | 2 +- ..._export_example_repository_with_teams_relation_blueprint.mdx | 2 +- .../_github_export_example_team_blueprint.mdx | 2 +- ...b_exporter_example_repository_with_teams_port_app_config.mdx | 2 +- .../example-team-members/_github_exporter_team_blueprint.mdx | 2 +- .../_github_exporter_team_member_blueprint.mdx | 2 +- .../_github_team_member_port_app_config.mdx | 2 +- .../_git_exporter_example_workflow_blueprint.mdx | 2 +- .../_git_exporter_example_workflow_run_blueprint.mdx | 2 +- .../_github_exporter_example_wf_wfr_port_app_config.mdx | 2 +- 34 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx index 4f318536ee..546e6542ef 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx index 8662aeaf6f..b418c67023 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx @@ -1,5 +1,5 @@
-Pull request blueprint (click to expand) +Pull request blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx index b61a1b225c..8dd70acc9e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (click to expand) +Repository blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx index ccbd0f6c2c..e7515015ce 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx @@ -1,5 +1,5 @@
-Branch blueprint (click to expand) +Branch blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx index f69b454690..d79657d62f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx @@ -1,5 +1,5 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx index cf3e477199..f5ac251991 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx @@ -1,5 +1,5 @@
-Deployment blueprint (click to expand) +Deployment blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx index 9735a19abb..2ff6bf7b33 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx index 2d5835f1f1..506f4f8409 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx @@ -1,5 +1,5 @@
-Deployment Environment blueprint (click to expand) +Deployment Environment blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx index 72dca8da19..c7a4e2546e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx @@ -1,5 +1,5 @@
- File Blueprint (click to expand) + File Blueprint (Click to expand) ```yaml showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx index cc24964830..826030775f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx @@ -1,5 +1,5 @@
- Port app config (click to expand) + Port app config (Click to expand) ```yaml showLineNumbers deleteDependentEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx index e190d68b2f..a55794eecb 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx @@ -1,5 +1,5 @@
-Issue blueprint (click to expand) +Issue blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx index 8d83290f5f..28ab7507cd 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx index d86acc7e8f..cca4e57651 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx index e29f09f82d..85151d7e0c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (click to expand) +Repository blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx index 3983c5934c..861b58725c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) + Port port-app-config.yml (Click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx index 3efe9b1d0e..4220ccb8df 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx @@ -1,5 +1,5 @@
-Github Users blueprint (click to expand) +Github Users blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx index 9cc92696c3..69e15479f9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx @@ -1,5 +1,5 @@
-Users blueprint (click to expand) +Users blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx index 0676142cb5..35062b3d7e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx @@ -1,5 +1,5 @@
-Code scan Alert blueprint (click to expand) +Code scan Alert blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx index ab88d9f34e..193fee863e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx @@ -1,5 +1,5 @@
-Dependabot Alert blueprint (click to expand) +Dependabot Alert blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx index 0cf692f692..03977af6b2 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx index 8c954a9646..0170894c01 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx @@ -1,5 +1,5 @@
-Collaborator blueprint (click to expand) +Collaborator blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx index 8c1ea31640..b5caa875d2 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) + Port port-app-config.yml (Click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx index 3bae16bcb1..08e6c9f504 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx @@ -1,5 +1,5 @@
-Release blueprint (click to expand) +Release blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx index 130b6b5024..f27d45759a 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) + Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx index 6b8b8ad673..eb224fa4d6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx @@ -1,5 +1,5 @@
-Tag blueprint (click to expand) +Tag blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx index b5a2f87313..24c221c496 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (click to expand) +Repository blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx index d938577bc7..46aa0a3818 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx @@ -1,5 +1,5 @@
-Team blueprint (click to expand) +Team blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx index d4c35fe4c7..4997293817 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (click to expand) + Port port-app-config.yml (Click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx index 75fa2374a6..0005fa8cf8 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx @@ -1,5 +1,5 @@
- Team Blueprint (click to expand) + Team Blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx index 15d590892a..5fd1fd09b9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -1,5 +1,5 @@
- Team Member Blueprint (click to expand) + Team Member Blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx index af68eeb205..be0b5b0bfc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx @@ -1,5 +1,5 @@
- Port port-app-config.yaml (click to expand) + Port port-app-config.yaml (Click to expand) ```yaml showLineNumbers - kind: team diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx index 26388841c8..72fff82659 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx @@ -1,5 +1,5 @@
-Workflow blueprint (click to expand) +Workflow blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx index 8e0833d89d..5b0a2db9d4 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx @@ -1,5 +1,5 @@
-Workflow run blueprint (click to expand) +Workflow run blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx index 045f11abaa..e7f0f7aa88 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (click to expand) +Port port-app-config.yml (Click to expand) ```yaml showLineNumbers resources: From 4bad248f5b77647f62e93013f32700452ad0e9d8 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 18 Aug 2025 15:39:47 +0100 Subject: [PATCH 18/25] Update tone use --- .../git/github-ocean/examples/examples.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index dea2e5266e..ffe9a7e97b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -126,7 +126,7 @@ The following example demonstrates mapping files to repository. ## Map repositories and monorepos -In the following example you will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`: +In the following example we will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`: @@ -188,7 +188,7 @@ You can use the following Port blueprint definitions and `port-app-config.yml`: ## Map teams and team members -The following shows how you can map teams and team members using the "members" selector. +The following shows how we can map teams and team members using the "members" selector. From f80af2b3f89fc9e0b3eb56ef3610471ff2b86d73 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 20 Aug 2025 11:22:24 +0100 Subject: [PATCH 19/25] Add necessary organization permission for syncing external identities --- .../git/github-ocean/installation/github-app.mdx | 1 + .../git/github-ocean/installation/installation.mdx | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx index c4c263bb32..4e3d2f2323 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/github-app.mdx @@ -54,6 +54,7 @@ This page outlines the following steps: - Environments: Readonly - **Organization Permissions:** - Members: Readonly (for syncing members and teams). + - Administration: Readonly(for syncing external identities) - Webhooks: Read and Write (to allow the integration create webhook). Then select "Create GitHub App" diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx index b4d197a3f9..ba2ee8e661 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx @@ -46,7 +46,7 @@ To create a personal access token see Github's [managing your personal access to **Repository permissions:** - **Content**: Readonly (For reading files) - **Metadata**: Readonly - - **Administration:** Readonly (for syncing github teams and collaborators) + - **Administration:** Readonly (for syncing repository teams and collaborators) - **Pull Requests**: Readonly - **Issues**: Readonly - **Actions**: Readonly @@ -56,7 +56,8 @@ To create a personal access token see Github's [managing your personal access to - **Environments**: Readonly **Organization permissions:** - - **Members**: Readonly(for syncing users) + - **Members**: Readonly(for syncing users and teams) + - **Administration**: Readonly(for syncing external identities) - **Webhooks**: Read and Write (for managing webhook) From 4a059e7e52c17a16cb2bc65d0bbb00222391bf4f Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 20 Aug 2025 11:30:19 +0100 Subject: [PATCH 20/25] Fix collaborator mappings --- ...github_exporter_example_admins_users_port_app_config.mdx | 6 +++--- ...porter_example_repository_with_teams_port_app_config.mdx | 3 ++- .../git/github-ocean/examples/examples.md | 2 ++ 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx index 861b58725c..2b43abffe6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -20,7 +20,7 @@ resources: url: .html_url defaultBranch: .default_branch relations: - admins: "[.collaborators[] | select(.is_admin == true) | .login]" + admins: "[.__collaborators[] | select(.is_admin == true) | .login]" - kind: user selector: query: "true" @@ -41,8 +41,8 @@ resources: identifier: .email title: .email blueprint: '"user"' - relations: - user: .email + properties: + email: .email ```
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx index 4997293817..58cb6bd08e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -8,6 +8,7 @@ resources: - kind: team selector: query: "true" # JQ boolean query. If evaluated to false - skip syncing the object. + members: false port: entity: mappings: @@ -36,7 +37,7 @@ resources: url: .html_url defaultBranch: .default_branch relations: - githubTeams: "[.teams[].id | tostring]" + githubTeams: "[.__teams[].id | tostring]" ```
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index ffe9a7e97b..88180332bc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -204,6 +204,8 @@ You can use the following Port blueprint definitions and `port-app-config.yml`: + +

Supported GitHub user types

From d9e5cda278a509e420d668b2d233232ed322fc9c Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 20 Aug 2025 12:10:44 +0100 Subject: [PATCH 21/25] Fix tip --- .../sync-data-to-catalog/git/github-ocean/examples/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index 88180332bc..9e3777eabc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -168,7 +168,7 @@ The following example demonstrates how to ingest your GitHub repositories, their -::: tip learn more +:::tip learn more - Click [Here](https://docs.github.com/en/rest/actions/workflows#get-a-workflow) for the GitHub workflow object structure. - Click [Here](https://docs.github.com/en/rest/actions/workflow-runs#get-a-workflow-run) for the GitHub workflow run object structure. From 44a2fbb1415831918ca56347cb47bc3c7688e213 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 20 Aug 2025 13:25:27 +0100 Subject: [PATCH 22/25] Improve formatting consistency --- .../examples/_github_exporter_example_port_app_config.mdx | 2 +- .../_github_exporter_example_pull_request_blueprint.mdx | 2 +- .../_github_exporter_example_repository_blueprint.mdx | 2 +- .../_git_exporter_example_branch_blueprint.mdx | 2 +- .../_github_exporter_example_branch_port_app_config.mdx | 2 +- .../_github_exporter_example_deployment_blueprint.mdx | 2 +- ...example_deployments_and_environments_port_app_config.mdx | 2 +- .../_github_exporter_example_environment_blueprint.mdx | 2 +- .../examples/example-file-kind/_example_file_blueprint.mdx | 2 +- .../examples/example-file-kind/_file_repo_app_config.mdx | 2 +- .../example-issue/_git_exporter_example_issue_blueprint.mdx | 2 +- .../_github_exporter_example_issue_port_app_config.mdx | 2 +- .../_github_exporter_example_monorepo_port_app_config.mdx | 2 +- ...rt_example_repository_with_admins_relation_blueprint.mdx | 2 +- ...github_exporter_example_admins_users_port_app_config.mdx | 2 +- .../_github_exporter_example_github_users_blueprint.mdx | 2 +- .../_github_exporter_example_users_blueprint.mdx | 2 +- .../_github_exporter_example_codeScan_alert_blueprint.mdx | 2 +- .../_github_exporter_example_dependabot_alert_blueprint.mdx | 2 +- ...hub_exporter_example_repo_dependabot_port_app_config.mdx | 2 +- .../_github_exporter_example_collaborator_blueprint.mdx | 2 +- ...rter_example_repository_collaborator_port_app_config.mdx | 2 +- .../_github_exporter_example_release_blueprint.mdx | 2 +- ..._github_exporter_example_release_tag_port_app_config.mdx | 2 +- .../_github_exporter_example_tag_blueprint.mdx | 2 +- ...ort_example_repository_with_teams_relation_blueprint.mdx | 2 +- .../_github_export_example_team_blueprint.mdx | 2 +- ...porter_example_repository_with_teams_port_app_config.mdx | 2 +- .../_github_exporter_team_blueprint.mdx | 2 +- .../_github_exporter_team_member_blueprint.mdx | 2 +- .../_github_team_member_port_app_config.mdx | 2 +- .../_git_exporter_example_workflow_blueprint.mdx | 2 +- .../_git_exporter_example_workflow_run_blueprint.mdx | 2 +- .../_github_exporter_example_wf_wfr_port_app_config.mdx | 2 +- .../git/github-ocean/examples/examples.md | 6 +++--- 35 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx index 3da7aa2a9c..a45dd95779 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx index b418c67023..8662aeaf6f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_pull_request_blueprint.mdx @@ -1,5 +1,5 @@
-Pull request blueprint (Click to expand) +Pull request blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx index 8dd70acc9e..b61a1b225c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/_github_exporter_example_repository_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (Click to expand) +Repository blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx index e7515015ce..ccbd0f6c2c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_git_exporter_example_branch_blueprint.mdx @@ -1,5 +1,5 @@
-Branch blueprint (Click to expand) +Branch blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx index d79657d62f..f69b454690 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-branch/_github_exporter_example_branch_port_app_config.mdx @@ -1,5 +1,5 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx index f5ac251991..f7ceefebcb 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx @@ -1,5 +1,5 @@
-Deployment blueprint (Click to expand) +Deployment blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx index 2ff6bf7b33..9735a19abb 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployments_and_environments_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx index 506f4f8409..2d5835f1f1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx @@ -1,5 +1,5 @@
-Deployment Environment blueprint (Click to expand) +Deployment Environment blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx index c7a4e2546e..7322a9c412 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_example_file_blueprint.mdx @@ -1,5 +1,5 @@
- File Blueprint (Click to expand) + File Blueprint (click to expand) ```yaml showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx index 826030775f..cc24964830 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-file-kind/_file_repo_app_config.mdx @@ -1,5 +1,5 @@
- Port app config (Click to expand) + Port app config (click to expand) ```yaml showLineNumbers deleteDependentEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx index a55794eecb..e190d68b2f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_git_exporter_example_issue_blueprint.mdx @@ -1,5 +1,5 @@
-Issue blueprint (Click to expand) +Issue blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx index 28ab7507cd..8d83290f5f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-issue/_github_exporter_example_issue_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx index cca4e57651..d86acc7e8f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx index 85151d7e0c..e29f09f82d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_export_example_repository_with_admins_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (Click to expand) +Repository blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx index 2b43abffe6..92ad06c3be 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_admins_users_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (Click to expand) + Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx index 4220ccb8df..3efe9b1d0e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_github_users_blueprint.mdx @@ -1,5 +1,5 @@
-Github Users blueprint (Click to expand) +Github Users blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx index 69e15479f9..9cc92696c3 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx @@ -1,5 +1,5 @@
-Users blueprint (Click to expand) +Users blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx index 35062b3d7e..0676142cb5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_codeScan_alert_blueprint.mdx @@ -1,5 +1,5 @@
-Code scan Alert blueprint (Click to expand) +Code scan Alert blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx index 193fee863e..ab88d9f34e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_dependabot_alert_blueprint.mdx @@ -1,5 +1,5 @@
-Dependabot Alert blueprint (Click to expand) +Dependabot Alert blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx index 03977af6b2..0cf692f692 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-alerts/_github_exporter_example_repo_dependabot_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx index 0170894c01..8c954a9646 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_collaborator_blueprint.mdx @@ -1,5 +1,5 @@
-Collaborator blueprint (Click to expand) +Collaborator blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx index b5caa875d2..8c1ea31640 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (Click to expand) + Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx index 08e6c9f504..3bae16bcb1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx @@ -1,5 +1,5 @@
-Release blueprint (Click to expand) +Release blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx index f27d45759a..130b6b5024 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_tag_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (Click to expand) + Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx index eb224fa4d6..6b8b8ad673 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx @@ -1,5 +1,5 @@
-Tag blueprint (Click to expand) +Tag blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx index 24c221c496..b5a2f87313 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_repository_with_teams_relation_blueprint.mdx @@ -1,5 +1,5 @@
-Repository blueprint (Click to expand) +Repository blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx index 46aa0a3818..d938577bc7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_export_example_team_blueprint.mdx @@ -1,5 +1,5 @@
-Team blueprint (Click to expand) +Team blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx index 58cb6bd08e..75755fa2a1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx @@ -1,6 +1,6 @@
- Port port-app-config.yml (Click to expand) + Port port-app-config.yml (click to expand) ```yaml showLineNumbers createMissingRelatedEntities: true diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx index 0005fa8cf8..75fa2374a6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx @@ -1,5 +1,5 @@
- Team Blueprint (Click to expand) + Team Blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx index 5fd1fd09b9..15d590892a 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -1,5 +1,5 @@
- Team Member Blueprint (Click to expand) + Team Member Blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx index be0b5b0bfc..af68eeb205 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx @@ -1,5 +1,5 @@
- Port port-app-config.yaml (Click to expand) + Port port-app-config.yaml (click to expand) ```yaml showLineNumbers - kind: team diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx index 72fff82659..26388841c8 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_blueprint.mdx @@ -1,5 +1,5 @@
-Workflow blueprint (Click to expand) +Workflow blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx index 5b0a2db9d4..8e0833d89d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_git_exporter_example_workflow_run_blueprint.mdx @@ -1,5 +1,5 @@
-Workflow run blueprint (Click to expand) +Workflow run blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx index e7f0f7aa88..045f11abaa 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-workflow-workflowrun/_github_exporter_example_wf_wfr_port_app_config.mdx @@ -1,6 +1,6 @@
-Port port-app-config.yml (Click to expand) +Port port-app-config.yml (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md index b8ab84625e..4367760996 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md @@ -90,7 +90,7 @@ Additionally, you can configure your selector to limit the number of closed pull ## Map repositories and issues -In the following example you will ingest your GitHub repositories and their issues to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: +The following example demonstrates how to ingest your GitHub repositories and their issues to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: @@ -139,14 +139,14 @@ The following example demonstrates mapping files to repository. ## Map repositories and monorepos -In the following example we will ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`: +The following example demonstrates how to ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`: -To retrieve the root folders of your monorepo, you can use this following syntax in your `port-app-config.yml`: +To retrieve the root folders of your monorepo, use the following syntax in your `port-app-config.yml`: ```yaml - kind: folder From 4d4f0485a8572edb1261a6c8d92ead4a8e9a8a95 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 20 Aug 2025 13:31:14 +0100 Subject: [PATCH 23/25] fix "Blueprint" and "blueprint" inconsistency --- .../example-team-members/_github_exporter_team_blueprint.mdx | 2 +- .../_github_exporter_team_member_blueprint.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx index 75fa2374a6..2f90b1cb9d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_blueprint.mdx @@ -1,5 +1,5 @@
- Team Blueprint (click to expand) + Team blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx index 15d590892a..c1306b7779 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -1,5 +1,5 @@
- Team Member Blueprint (click to expand) + Team Member blueprint (click to expand) ```json showLineNumbers { From 47e36811c6dff021e883417eb33064a1afbe8800 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Thu, 21 Aug 2025 10:03:42 +0100 Subject: [PATCH 24/25] Remove extra line breaks in collaborator --- ...ple_repository_collaborator_port_app_config.mdx | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx index 8c1ea31640..c93a368f72 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx @@ -36,20 +36,6 @@ resources: role: .role_name relations: repository: .__repository - - - - - - - - - - - - - - ```
From 9818567e6016ad229611f781e486f5e19d752869 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Thu, 21 Aug 2025 12:01:25 +0100 Subject: [PATCH 25/25] Make team members more consistent --- .../_github_exporter_team_member_blueprint.mdx | 6 +++--- .../_github_team_member_port_app_config.mdx | 4 +--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx index c1306b7779..06b188902c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_exporter_team_member_blueprint.mdx @@ -8,9 +8,9 @@ "icon": "Github", "schema": { "properties": { - "all": { - "type": "object", - "title": "all" + "name": { + "type": "string", + "title": "Name" } }, "required": [] diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx index af68eeb205..cfcdb8712b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx @@ -32,8 +32,6 @@ title: .login blueprint: '"githubTeamMember"' properties: - all: . - - + name: .name ```