Align more with Backstage to make more generic

Author: cliftonc

readme.md

@@ -16,8 +16,8 @@ This action expects a Notion database with the following properties, this will b
   - Description: text
   - Kind: select
   - URL: url
-  - Segment: select
-  - Team: select
+  - Owner: select
+  - System: select
   - Tags: multi_select
   - Visibility: select
   - Language: select
@@ -34,14 +34,14 @@ It looks like this after it has run:
 
 You have an option to provide additional 'lookup' databases to convert some of the above selects into relations:
 
-### Segment, Team, System
+### Owner, System
 
 1. Create a database that has *at least* a `Name` column that is unique, all other columns are up to you.
 2. Create an 'Unknown' row - this is what services that cannot be mapped go to (this name matters).
-3. In the config of the action, provide the input variable `segment_database` pointing to this database.
-4. In the main service catalogue table convert the `Segment` column to a relation, pointing at the above database.
+3. In the config of the action, provide the input variable `owner_database` pointing to this database.
+4. In the main service catalogue table convert the `Owner` column to a relation, pointing at the above database.
 
-This can be repeated for `Team` and `System`.  The full config is below in the usage.
+This can be repeated for `System`.  The full config is below in the usage.
 
 ## Service Descriptor Format
 
@@ -70,8 +70,7 @@ jobs:
          github_token: ${{ secrets.PAT_GITHUB_TOKEN }}
          notion_token: ${{ secrets.NOTION_TOKEN }}
          database: 2b26b4290cc84d95ad3e93c3255277a1    
-         segment_database: 7943615f4dba43b3a3b0f991f4f7136d
-         team_database: c11736fe61b941149de098676bde8d92
+         owner_database: 7943615f4dba43b3a3b0f991f4f7136d
          system_database: 121534684fe840a1953500e603c2b602
          repository_type: all
          catalog_file: catalog-info.yaml

src/index.js

@@ -8,8 +8,7 @@ try {
   const GITHUB_TOKEN = core.getInput('github_token')
   const database = core.getInput('database')
   const systemDb = core.getInput('system_database')
-  const segmentDb = core.getInput('segment_database')
-  const teamDb = core.getInput('team_database')
+  const ownerDb = core.getInput('owner_database')  
   const owner = core.getInput('github_owner')
   const catalogFile = core.getInput('catalog_file') || 'catalog-info.yaml'
   const repositoryType = core.getInput('repository_type') || 'all'
@@ -56,40 +55,23 @@ try {
     return repoData
   }
 
-  const createProperties = (repo, { systems, segments, teams }) => {
-    let segment, team, system
-    const segmentAnnotation = repo?.metadata?.annotations?.segment
-    const systemAnnotation = repo?.metadata?.annotations?.system
-    const teamAnnotation = repo?.metadata?.annotations?.team
+  const createProperties = (repo, { systems, owners }) => {
+    let owner, system
+    const ownerSpec = repo?.spec?.owner
+    const systemSpec = repo?.spec?.system
 
-    if (segments) {
-      // Segments are a relation
-      segment = {
-        relation: [
-          { id: segments[segmentAnnotation?.toLowerCase()] || segments.unknown }
-        ]
-      }
-    } else {
-      // Segments are a tag
-      segment = {
-        select: {
-          name: segmentAnnotation || 'Unknown'
-        }
-      }
-    }
-
-    if (teams) {
-      // Teams are a relation
-      team = {
+    if (owners) {
+      // Owners are a relation
+      owner = {
         relation: [
-          { id: teams[teamAnnotation?.toLowerCase()] || teams.unknown }
+          { id: owners[ownerSpec?.toLowerCase()] || owners.unknown }
         ]
       }
     } else {
-      // Teams are a tag
-      team = {
+      // owners are a tag
+      owner = {
         select: {
-          name: teamAnnotation || 'Unknown'
+          name: ownerSpec || 'Unknown'
         }
       }
     }
@@ -98,14 +80,14 @@ try {
       // Segments are a relation
       system = {
         relation: [
-          { id: systems[systemAnnotation?.toLowerCase()] || systems.unknown }
+          { id: systems[systemSpec?.toLowerCase()] || systems.unknown }
         ]
       }
     } else {
       // Segments are a tag
       system = {
         select: {
-          name: systemAnnotation || 'Unknown'
+          name: systemSpec || 'Unknown'
         }
       }
     }
@@ -137,8 +119,7 @@ try {
       URL: {
         url: repo._repo.html_url
       },
-      Segment: segment,
-      Team: team,
+      Owner: owner,      
       System: system,
       Visibility: {
         select: {
@@ -166,31 +147,31 @@ try {
     }
   }
 
-  const updateNotionRow = async (repo, pageId, { systems, segments, teams }) => {
+  const updateNotionRow = async (repo, pageId, { systems, owners }) => {
     try {
       await notion.pages.update({
         page_id: pageId,
-        properties: createProperties(repo, { systems, segments, teams })
+        properties: createProperties(repo, { systems, owners })
       })
     } catch (ex) {
       core.error(`Error updating notion document for ${repo._repo.name}: ${ex.message} ...`)
     }
   }
 
-  const createNotionRow = async (repo, { systems, segments, teams }) => {
+  const createNotionRow = async (repo, { systems, owners }) => {
     try {
       await notion.pages.create({
         parent: {
           database_id: database
         },
-        properties: createProperties(repo, { systems, segments, teams })
+        properties: createProperties(repo, { systems, owners })
       })
     } catch (ex) {
       core.error(`Error creating notion document for ${repo._repo.name}: ${ex.message} ...`)
     }
   }
 
-  const updateNotion = async (repositories, { systems, segments, teams }) => {
+  const updateNotion = async (repositories, { systems, owners }) => {
     for (const repo of repositories) {
       // Lets see if we can find the row
       const search = await notion.databases.query({
@@ -208,9 +189,9 @@ try {
       // Lets just update the first one to not make the problem worse
       if (search.results.length > 0) {
         const pageId = search.results[0].id
-        await updateNotionRow(repo, pageId, { systems, segments, teams })
+        await updateNotionRow(repo, pageId, { systems, owners })
       } else {
-        await createNotionRow(repo, { systems, segments, teams })
+        await createNotionRow(repo, { systems, owners })
       }
     }
   }
@@ -225,38 +206,27 @@ try {
       return parent
     }
 
-    let systemRows, segmentRows, teamRows
+    let systemRows, ownerRows
 
     if (systemDb) {
       systemRows = await notion.databases.query({
         database_id: systemDb
       })
     }
 
-    if (segmentDb) {
-      segmentRows = await notion.databases.query({
-        database_id: segmentDb
-      })
-    }
-
-    if (teamDb) {
-      teamRows = await notion.databases.query({
-        database_id: teamDb
+    if (ownerDb) {
+      ownerRows = await notion.databases.query({
+        database_id: ownerDb
       })
     }
 
-    const systems = processRows(systemRows) || null
-    const teams = processRows(teamRows) || null
-    const segments = processRows(segmentRows) || null
+    const systems = processRows(systemRows) || null    
+    const owners = processRows(ownerRows) || null
     let error = false
 
-    if (segmentDb && !segments.unknown) {
-      error = true
-      core.error('Your segment table does not contain an "unknown" row!')
-    }
-    if (teamDb && !teams.unknown) {
+    if (ownerDb && !owners.unknown) {
       error = true
-      core.error('Your team table does not contain an "unknown" row!')
+      core.error('Your owner table does not contain an "unknown" row!')
     }
     if (systemDb && !systems.unknown) {
       error = true
@@ -269,23 +239,21 @@ try {
 
     return {
       systems,
-      segments,
-      teams
+      owners
     }
   }
 
   const refreshData = async () => {
-    core.startGroup('Loading systems, segments and teams')
-    const { systems, segments, teams } = await loadData()
+    core.startGroup('Loading systems and owners ...')
+    const { systems, owners } = await loadData()
     core.info(`Loaded ${Object.keys(systems || {}).length} systems`)
-    core.info(`Loaded ${Object.keys(segments || {}).length} segments`)
-    core.info(`Loaded ${Object.keys(teams || {}).length} teams`)
+    core.info(`Loaded ${Object.keys(owners || {}).length} owners`)
     core.endGroup()
     core.startGroup('🌀 Getting github repositories')
     const repositories = await getRepos()
     core.endGroup()
     core.startGroup(`✨ Updating notion with ${repositories.length} services ...`)
-    await updateNotion(repositories, { systems, segments, teams })
+    await updateNotion(repositories, { systems, owners })
     core.endGroup()
   }
 

src/index.test.js

@@ -10,8 +10,7 @@ test('complete input should succeed with default inputs', () => {
   process.env.INPUT_GITHUB_TOKEN = process.env.GITHUB_TOKEN
   process.env.INPUT_REPOSITORY_TYPE = 'public'
   process.env.INPUT_GITHUB_OWNER = 'infinitaslearning'
-  process.env.INPUT_SEGMENT_DATABASE = '7943615f4dba43b3a3b0f991f4f7136d'
-  process.env.INPUT_TEAM_DATABASE = 'c11736fe61b941149de098676bde8d92'
+  process.env.INPUT_OWNER_DATABASE = '7943615f4dba43b3a3b0f991f4f7136d'  
   process.env.INPUT_SYSTEM_DATABASE = '121534684fe840a1953500e603c2b602'
 
   const ip = path.join(__dirname, 'index.js')

src/local.js

@@ -7,15 +7,13 @@ process.env.INPUT_GITHUB_TOKEN = process.env.GITHUB_TOKEN
 process.env.INPUT_REPOSITORY_TYPE = 'public'
 process.env.INPUT_GITHUB_OWNER = 'infinitaslearning'
 
-// process.env.INPUT_DATABASE = 'cecaf0beb15945158d155866ff9acce8' // '2b26b4290cc84d95ad3e93c3255277a1'
-// process.env.INPUT_SEGMENT_DATABASE = '7943615f4dba43b3a3b0f991f4f7136d'
-// process.env.INPUT_TEAM_DATABASE = 'c11736fe61b941149de098676bde8d92'
-// process.env.INPUT_SYSTEM_DATABASE = '121534684fe840a1953500e603c2b602'
-
-process.env.INPUT_DATABASE = '2b26b4290cc84d95ad3e93c3255277a1' // '2b26b4290cc84d95ad3e93c3255277a1'
-process.env.INPUT_SEGMENT_DATABASE = '3ee0d01944924634990b42b44253d370'
-process.env.INPUT_TEAM_DATABASE = '9baf04c267054f0294aeab25026ce74f'
-process.env.INPUT_SYSTEM_DATABASE = 'c721d8f0e6e34961ba037c67ad632585'
+process.env.INPUT_DATABASE = 'cecaf0beb15945158d155866ff9acce8' // '2b26b4290cc84d95ad3e93c3255277a1'
+process.env.INPUT_OWNER_DATABASE = '7943615f4dba43b3a3b0f991f4f7136d'
+process.env.INPUT_SYSTEM_DATABASE = '121534684fe840a1953500e603c2b602'
+
+// process.env.INPUT_DATABASE = '2b26b4290cc84d95ad3e93c3255277a1' // '2b26b4290cc84d95ad3e93c3255277a1'
+// process.env.INPUT_OWNER_DATABASE = '3ee0d01944924634990b42b44253d370'
+// process.env.INPUT_SYSTEM_DATABASE = 'c721d8f0e6e34961ba037c67ad632585'
 
 const ip = path.join(__dirname, 'index.js')
 const options = {