Merge pull request #2944 from port-labs/PORT-16638-Fix-Default-Mapping-For-GitHub-Ocean

feat: sanitize GitHub user identifiers to handle special characters

Author: hadar-co

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

@@ -30,9 +30,9 @@ resources:
           title: ".title"
           blueprint: '"githubPullRequest"'
           properties:
-            creator: ".user.login"
-            assignees: "[.assignees[].login]"
-            reviewers: "[.requested_reviewers[].login]"
+            creator: (.user.login | gsub("\\["; "-") | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; ""))
+            assignees: '[.assignees[].login | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")]'
+            reviewers: '[.requested_reviewers[].login | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")]'
             status: ".state" # merged, closed, opened
             closedAt: ".closed_at"
             updatedAt: ".updated_at"

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,3 +1,6 @@
+import Tabs from "@theme/Tabs"
+import TabItem from "@theme/TabItem"
+
 <details>
 
 <summary><b> Port port-app-config.yml (click to expand)</b></summary>
@@ -20,14 +23,15 @@ resources:
             url: .html_url
             defaultBranch: .default_branch
           relations:
-            admins: "[.__collaborators[] | select(.is_admin == true) | .login]"
+            admins: "[.__collaborators[] | select(.is_admin == true) | .login | gsub("\\["; "-") | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")]"
   - kind: user
     selector:
       query: "true"
+      includeBots: "false"
     port:
       entity:
         mappings:
-          identifier: .login
+          identifier: .login | gsub("\\["; "-") | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")
           title: if (.name != "" and .name) then .name else .login end
           blueprint: '"githubUser"'
           relations:
@@ -46,3 +50,21 @@ resources:
 ```
 
 </details>
+
+<Tabs groupId="config" queryString="parameter">
+
+<TabItem label="Include Bot Users" value="includeBots">
+
+    The `includeBots` selector is used to include bot users in the sync process. By default, it is set to `false`.
+
+    ```yaml
+    - kind: user
+      selector:
+        query: 'true'
+        # highlight-next-line
+        includeBots: 'false'
+    ```
+
+</TabItem>
+
+</Tabs>

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 @@
 <details>
-  <summary><b>Port port-app-config.yaml (click to expand)</b></summary>
+<summary><b>Port port-app-config.yaml (click to expand)</b></summary>
 
 ```yaml showLineNumbers
   - kind: team
@@ -19,7 +19,7 @@
             permission: .permission
             notification_setting: .notificationSetting
           relations:
-            team_member: '[.members.nodes[].login]'
+            team_member: '[.members.nodes[].login | gsub("\\["; "-") | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")]'
   - kind: team
     selector:
       query: 'true'
@@ -28,7 +28,7 @@
       itemsToParse: .members.nodes
       entity:
         mappings:
-          identifier: .login
+          identifier: .login | gsub("\\["; "-") | gsub("\\](?=[^$])"; "-") | gsub("\\]$"; "")
           title: .login
           blueprint: '"githubTeamMember"'
           properties: