From f6195aeb896c8c21f34701245d53934d467183c6 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:04:48 +0100 Subject: [PATCH 01/13] Add documentation examples for release, tags, deployments, and environments --- ..._exporter_example_deployment_blueprint.mdx | 58 ++++++++++++++++++ ...ments_and_environments_port_app_config.mdx | 60 +++++++++++++++++++ ...exporter_example_environment_blueprint.mdx | 51 ++++++++++++++++ ...hub_exporter_example_release_blueprint.mdx | 48 +++++++++++++++ ...er_example_release_tag_port_app_config.mdx | 52 ++++++++++++++++ ..._github_exporter_example_tag_blueprint.mdx | 34 +++++++++++ .../git/github-ocean/examples/examples.md | 30 ++++++++++ 7 files changed, 333 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx create mode 100644 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 create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx create mode 100644 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 create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx 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 new file mode 100644 index 0000000000..4761d5f753 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_deployment_blueprint.mdx @@ -0,0 +1,58 @@ +
+Deployment blueprint + +```json showLineNumbers +{ + "identifier": "githubDeployment", + "title": "Deployment", + "icon": "Deployment", + "schema": { + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ref": { + "title": "Ref", + "type": "string" + }, + "sha": { + "title": "Sha", + "type": "string" + }, + "transientEnvironment": { + "title": "Transient Running Service", + "type": "boolean" + }, + "productionEnvironment": { + "title": "Production Running Service", + "type": "boolean" + }, + "createdAt": { + "title": "Created At", + "type": "string", + "format": "date-time" + }, + "url": { + "title": "URL", + "type": "string", + "icon": "Link", + "format": "url" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "relations": { + "runningService": { + "title": "Running Service", + "target": "githubRepoEnvironment", + "required": false, + "many": false + } + } +} +``` + +
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 new file mode 100644 index 0000000000..bc0a1f8579 --- /dev/null +++ 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 @@ -0,0 +1,60 @@ +
+ + Port port-app-config.yml + +```yaml +createMissingRelatedEntities: true +repositoryType: 'all' +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: environment + selector: + query: "true" + port: + entity: + mappings: + identifier: .repo + '-' + .name + title: .name + blueprint: '"githubRepoEnvironment"' + properties: + url: .html_url + customBranchesPolicies: .custom_branches_policies + protectedBranches: .protected_branches + createdAt: .created_at + updatedAt: .updated_at + relations: + repository: .repo + - kind: deployment + selector: + query: "true" + port: + entity: + mappings: + identifier: .repo + '-' + (.id|tostring) + title: .task + '-' + .environment + blueprint: '"githubDeployment"' + properties: + description: .description + ref: .ref + sha: .sha + productionEnvironment: .production_environment + transientEnvironment: .transient_environment + createdAt: .created_at + url: .url + relations: + environment: .repo + '-' + .environment +``` + +
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 new file mode 100644 index 0000000000..acaf7cae25 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-deployments-environments/_github_exporter_example_environment_blueprint.mdx @@ -0,0 +1,51 @@ +
+Running Service blueprint + +```json showLineNumbers +{ + "identifier": "githubRepoEnvironment", + "title": "Running Service", + "icon": "Environment", + "schema": { + "properties": { + "url": { + "icon": "DefaultProperty", + "title": "URL", + "type": "string", + "format": "url" + }, + "createdAt": { + "title": "Created At", + "type": "string", + "format": "date-time", + "icon": "DefaultProperty" + }, + "updatedAt": { + "title": "Updated At", + "type": "string", + "format": "date-time" + }, + "protectedBranches": { + "title": "Protected Branches", + "type": "boolean" + }, + "customBranchPolicies": { + "title": "Custom Branch Policies", + "type": "boolean" + } + }, + "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-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 new file mode 100644 index 0000000000..7550c595bc --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_release_blueprint.mdx @@ -0,0 +1,48 @@ +
+Release blueprint + +```json showLineNumbers +{ + "identifier": "githubRelease", + "title": "Release", + "icon": "Github", + "schema": { + "properties": { + "release_creation_time": { + "icon": "DefaultProperty", + "type": "string", + "title": "Release creation time", + "format": "date-time" + }, + "author": { + "type": "string", + "title": "Author" + }, + "description": { + "type": "string", + "title": "Description" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "repository": { + "title": "Repository", + "target": "githubRepository", + "required": false, + "many": false + }, + "tag": { + "title": "Tag", + "target": "tag", + "required": false, + "many": false + } + } +} +``` + +
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 new file mode 100644 index 0000000000..e33e12db5d --- /dev/null +++ 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 @@ -0,0 +1,52 @@ +
+ + Port port-app-config.yml + +```yaml showLineNumbers +repositoryType: 'all' +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: release + selector: + query: 'true' + port: + entity: + mappings: + identifier: .name + title: .name + blueprint: '"githubRelease"' + properties: + author: .author.login + description: .body + release_creation_time: .created_at + relations: + tag: .tag_name + repository: .__repository + - kind: tag + selector: + query: 'true' + port: + entity: + mappings: + identifier: .name + title: .name + blueprint: '"githubTag"' + properties: + commit_sha: .commit.sha + relations: + repository: .__repository +``` + +
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 new file mode 100644 index 0000000000..73fcd2f35e --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-release-tag/_github_exporter_example_tag_blueprint.mdx @@ -0,0 +1,34 @@ +
+Tag blueprint + +```json showLineNumbers + +{ + "identifier": "githubTag", + "title": "Tag", + "icon": "Github", + "schema": { + "properties": { + "commit_sha": { + "icon": "DefaultProperty", + "type": "string", + "title": "Commit sha" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "repository": { + "title": "Repository", + "target": "githubRepository", + "required": false, + "many": false + } + } +} +``` + +
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 fc1fc7b606..e212bf0bed 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,14 @@ 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 RepoEnvironmentBlueprint from './example-deployments-environments/\_github_exporter_example_environment_blueprint.mdx' +import DeploymentBlueprint from './example-deployments-environments/\_github_exporter_example_deployment_blueprint.mdx' +import PortRepoDeploymentAndEnvironmentAppConfig from './example-deployments-environments/\_github_exporter_example_deployments_and_environments_port_app_config.mdx' + +import TagBlueprint from './example-repository-release-tag/\_github_exporter_example_tag_blueprint.mdx' +import ReleaseBlueprint from './example-repository-release-tag/\_github_exporter_example_release_blueprint.mdx' +import RepositoryTagReleaseAppConfig from './example-repository-release-tag/\_github_exporter_example_release_tag_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' @@ -60,7 +68,29 @@ 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, deployments and environments + +In the following example you will ingest your GitHub repositories, their deployments and environments to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + + + +## Map repositories, repository releases and tags + +In the following example you will ingest your GitHub repositories, their releases and tags to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: + + + + + + + ## Map supported resources From ac205c06454bf9f1aa308daf49a9b3ccd7028f27 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:06:25 +0100 Subject: [PATCH 02/13] Updated supported resources --- .../github-ocean/_github_exporter_supported_resources.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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..d15a1914f3 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) - +- [`environment`](https://docs.github.com/en/rest/deployments/environments#get-an-environment) +- [`deployment`](https://docs.github.com/en/rest/deployments/deployments#get-a-deployment) +- [`releases`](https://docs.github.com/en/rest/releases/releases#list-releases) +- [`tags`](https://docs.github.com/en/rest/repos/repos#list-repository-tags) From 43c01632a966b3401d721116afdff7a6f98383dc Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:13:33 +0100 Subject: [PATCH 03/13] Update supported events --- src/components/ocean-saas-specifics/live-events.jsx | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/components/ocean-saas-specifics/live-events.jsx b/src/components/ocean-saas-specifics/live-events.jsx index ab549fae74..2f08973823 100644 --- a/src/components/ocean-saas-specifics/live-events.jsx +++ b/src/components/ocean-saas-specifics/live-events.jsx @@ -204,7 +204,12 @@ export const liveEvents = { \n - unassigned \ \n - review_request_removed \ \n - closed \ - \n\n **push:** ", + \n\n **push:** \ + \n\n **deployment:** \ + \n\n **deployment_status:** \ + \n\n **release:** \ + \n - created \ + \n - edited", }; export const OceanSaasLiveEventsTriggersOAuth = ({ id, isOAuth = false }) => { From bed03705acbe8218323a6186d35a6dcc4d84b920 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:20:04 +0100 Subject: [PATCH 04/13] Update required permissions --- .../git/github-ocean/installation/github-app.mdx | 2 ++ .../git/github-ocean/installation/installation.mdx | 2 ++ 2 files changed, 4 insertions(+) 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 8dae45cd83..4225e703a9 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 @@ -47,6 +47,8 @@ In organizations that have a self-hosted GitHub installation there is no access - Contents: Readonly (for reading port configuration files and repository files). - Metadata: Readonly. - Pull Request: Readonly + - Deployments: Readonly + - Environments: Readonly - **Organization Permissions:** - Webhooks: Read and Write (to allow the integration create webhook). 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..aa1ce7c48f 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,8 @@ To create a personal access token see Github's [managing your personal access to - **Content**: Readonly - **Metadata**: Readonly - **Pull Requests**: Readonly + - **Deployments**: Readonly + - **Environments**: Readonly **Organization permissions:** - **Webhooks**: Read and Write (for managing webhook) From de5ea2e87f3e3811da9acdb92ed20f60e1fa3908 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:23:03 +0100 Subject: [PATCH 05/13] Tiny correction to the event triggers --- src/components/ocean-saas-specifics/live-events.jsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/components/ocean-saas-specifics/live-events.jsx b/src/components/ocean-saas-specifics/live-events.jsx index 2f08973823..7ff8bde9a1 100644 --- a/src/components/ocean-saas-specifics/live-events.jsx +++ b/src/components/ocean-saas-specifics/live-events.jsx @@ -205,9 +205,9 @@ export const liveEvents = { \n - review_request_removed \ \n - closed \ \n\n **push:** \ - \n\n **deployment:** \ - \n\n **deployment_status:** \ - \n\n **release:** \ + \n\n **deployment** \ + \n\n **deployment_status** \ + \n\n **release** \ \n - created \ \n - edited", }; From 8d2dec60f3b09537e8860d5a2553fddc8d9984be Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:31:12 +0100 Subject: [PATCH 06/13] Update repository key in deployment --- ...ample_deployments_and_environments_port_app_config.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 bc0a1f8579..20c078579a 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 @@ -25,7 +25,7 @@ resources: port: entity: mappings: - identifier: .repo + '-' + .name + identifier: .__repository + '-' + .name title: .name blueprint: '"githubRepoEnvironment"' properties: @@ -35,14 +35,14 @@ resources: createdAt: .created_at updatedAt: .updated_at relations: - repository: .repo + repository: .__repository - kind: deployment selector: query: "true" port: entity: mappings: - identifier: .repo + '-' + (.id|tostring) + identifier: .__repository + '-' + (.id|tostring) title: .task + '-' + .environment blueprint: '"githubDeployment"' properties: @@ -54,7 +54,7 @@ resources: createdAt: .created_at url: .url relations: - environment: .repo + '-' + .environment + environment: .__repository + '-' + .environment ``` From 523c11bad83108a6d9420eabe05b943bd0c6a892 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:32:51 +0100 Subject: [PATCH 07/13] Update tag relation --- .../_github_exporter_example_release_blueprint.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 7550c595bc..0d20feb865 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 @@ -37,7 +37,7 @@ }, "tag": { "title": "Tag", - "target": "tag", + "target": "githubTag", "required": false, "many": false } From 323c9770de7c2dde72713c6a19c3f10ad3a45c9b Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 16 Jul 2025 15:46:46 +0100 Subject: [PATCH 08/13] Change release-tag order --- ...ter_example_release_tag_port_app_config.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) 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 e33e12db5d..62efcfdec7 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 @@ -18,7 +18,7 @@ resources: readme: file://README.md url: .html_url defaultBranch: .default_branch - - kind: release + - kind: tag selector: query: 'true' port: @@ -26,15 +26,12 @@ resources: mappings: identifier: .name title: .name - blueprint: '"githubRelease"' + blueprint: '"githubTag"' properties: - author: .author.login - description: .body - release_creation_time: .created_at + commit_sha: .commit.sha relations: - tag: .tag_name repository: .__repository - - kind: tag + - kind: release selector: query: 'true' port: @@ -42,10 +39,13 @@ resources: mappings: identifier: .name title: .name - blueprint: '"githubTag"' + blueprint: '"githubRelease"' properties: - commit_sha: .commit.sha + author: .author.login + description: .body + release_creation_time: .created_at relations: + tag: .tag_name repository: .__repository ``` From ab9b3859f813522d53b8e8c6c4752702d571471f Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Mon, 4 Aug 2025 14:06:28 +0100 Subject: [PATCH 09/13] Use double quotation in identifier --- ...deployments_and_environments_port_app_config.mdx | 13 ++++++------- ...exporter_example_release_tag_port_app_config.mdx | 1 - 2 files changed, 6 insertions(+), 8 deletions(-) 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 20c078579a..7b0f044c54 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 @@ -4,7 +4,6 @@ ```yaml createMissingRelatedEntities: true -repositoryType: 'all' resources: - kind: repository selector: @@ -25,13 +24,13 @@ resources: port: entity: mappings: - identifier: .__repository + '-' + .name + identifier: .__repository + "-" + .name title: .name blueprint: '"githubRepoEnvironment"' properties: url: .html_url - customBranchesPolicies: .custom_branches_policies - protectedBranches: .protected_branches + customBranchesPolicies: .deployment_branch_policy.custom_branches_policies + protectedBranches: .deployment_branch_policy.protected_branches createdAt: .created_at updatedAt: .updated_at relations: @@ -42,8 +41,8 @@ resources: port: entity: mappings: - identifier: .__repository + '-' + (.id|tostring) - title: .task + '-' + .environment + identifier: .__repository + "-" + (.id|tostring) + title: .task + "-" + .environment blueprint: '"githubDeployment"' properties: description: .description @@ -54,7 +53,7 @@ resources: createdAt: .created_at url: .url relations: - environment: .__repository + '-' + .environment + environment: .__repository + "-" + .environment ``` 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 62efcfdec7..6fb7c68fa1 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 @@ -3,7 +3,6 @@ Port port-app-config.yml ```yaml showLineNumbers -repositoryType: 'all' resources: - kind: repository selector: From 0fe5072575adb6f0fa583fe3b1e1f5b5e8411986 Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 6 Aug 2025 12:14:22 +0100 Subject: [PATCH 10/13] Add missing showlinenumbers and improve consistency --- .../_github_exporter_example_deployment_blueprint.mdx | 2 +- ...r_example_deployments_and_environments_port_app_config.mdx | 4 ++-- .../_github_exporter_example_environment_blueprint.mdx | 4 ++-- .../_github_exporter_example_release_blueprint.mdx | 2 +- .../_github_exporter_example_release_tag_port_app_config.mdx | 2 +- .../_github_exporter_example_tag_blueprint.mdx | 3 +-- 6 files changed, 8 insertions(+), 9 deletions(-) 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 4761d5f753..6cfdee0902 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 +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 7b0f044c54..c42a1b1877 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,8 +1,8 @@
- Port port-app-config.yml + Port port-app-config.yml (click to expand) -```yaml +```yaml showLineNumbers createMissingRelatedEntities: true resources: - kind: repository 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 acaf7cae25..c9e033f1a1 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,10 +1,10 @@
-Running Service blueprint +Running Service blueprint (click to expand) ```json showLineNumbers { "identifier": "githubRepoEnvironment", - "title": "Running Service", + "title": "Deployment Environments", "icon": "Environment", "schema": { "properties": { 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 0d20feb865..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 +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 6fb7c68fa1..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 + 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 73fcd2f35e..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,8 +1,7 @@
-Tag blueprint +Tag blueprint (click to expand) ```json showLineNumbers - { "identifier": "githubTag", "title": "Tag", From 0f74da2bd1bdb28b546ad8057fd2bf017610a4cc Mon Sep 17 00:00:00 2001 From: Melody Daniel Date: Wed, 6 Aug 2025 12:21:25 +0100 Subject: [PATCH 11/13] Fix claude suggestions --- .../_github_exporter_example_deployment_blueprint.mdx | 4 ++-- ...example_deployments_and_environments_port_app_config.mdx | 6 +++--- .../_github_exporter_example_environment_blueprint.mdx | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) 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 6cfdee0902..cf3e477199 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 @@ -45,8 +45,8 @@ "mirrorProperties": {}, "calculationProperties": {}, "relations": { - "runningService": { - "title": "Running Service", + "deployment_environment": { + "title": "Deployment Environment", "target": "githubRepoEnvironment", "required": false, "many": false 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 c42a1b1877..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 @@ -29,7 +29,7 @@ resources: blueprint: '"githubRepoEnvironment"' properties: url: .html_url - customBranchesPolicies: .deployment_branch_policy.custom_branches_policies + customBranchPolicies: .deployment_branch_policy.custom_branches_policies protectedBranches: .deployment_branch_policy.protected_branches createdAt: .created_at updatedAt: .updated_at @@ -53,7 +53,7 @@ resources: createdAt: .created_at url: .url relations: - environment: .__repository + "-" + .environment + deployment_environment: .__repository + "-" + .environment ```
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 c9e033f1a1..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 @@
-Running Service blueprint (click to expand) +Deployment Environment blueprint (click to expand) ```json showLineNumbers { From 28c74a67222bd04b45b6e73bc9edbbbbe0f38ffb Mon Sep 17 00:00:00 2001 From: sivanel97 Date: Mon, 11 Aug 2025 09:45:31 +0300 Subject: [PATCH 12/13] Update docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md --- .../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 5a4d5840e0..d5a482f2d5 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 @@ -68,7 +68,7 @@ The following example demonstrates mapping files to repository. ## Map repositories, deployments and environments -In the following example you will ingest your GitHub repositories, their deployments and environments 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, their deployments and environments to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: From 46acf221ee2ae34efd7784ad6dac531e2e4dbc8a Mon Sep 17 00:00:00 2001 From: sivanel97 Date: Mon, 11 Aug 2025 09:45:40 +0300 Subject: [PATCH 13/13] Update docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md --- .../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 d5a482f2d5..cd04fcb9ea 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 @@ -80,7 +80,7 @@ The following example demonstrates how to ingest your GitHub repositories, their ## Map repositories, repository releases and tags -In the following example you will ingest your GitHub repositories, their releases and tags 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, their releases and tags to Port, you may use the following Port blueprint definitions and `port-app-config.yml`: