microsoft/opensource-management-portal

BREAKING CHANGE: requiring organization IDs in configuration

Closed this issue · 1 comments

We've taken some changes recently to essentially expect an organization to have an id (number) configured, after a few too many times of being bitten by re-casing or renaming of organizations. Using an ID especially helps with the new query cache implementation that is a big performance boost when paired with an ongoing webhook event ingestion bus.

To get an organization ID, you can go to https://api.github.com/orgs/orgname and you will find it in there.

Once the modern GitHub App installation work is ready, in theory configuration could move from static files to a dynamic version that removes extra work, if people wanted that.

This is just an early heads up for now to be referenced once merged.

Adding the ID now will have no impact.

(Yes, the configuration needs to be documented better)

Here's an example of the current configuration for a dev environment we have...

[
  {
    "name": "ContosoDev",
    "id": 20195765,
    "type": "public",
    "ownerToken": "keyvault://portalppe.vault.azure.net/secrets/dev-github-org-contosodev-repos-token",
    "description": "Contoso Public Development - Cloud",
    "teamAllMembers": "2063735",
    "teamPortalSudoers": "2063734",
    "preventLargeTeamPermissions": true,
    "teamAllReposRead": "2280089",
    "teamAllReposWrite": "2148455",
    "templates": ["mit", "microsoft.docs", "dnfmit", "dnfmit.docs", "other"]
  },
  {
    "name": "contoso-d",
    "id": 9669768,
    "type": "public",
    "ownerToken": "keyvault://portalppe.vault.azure.net/secrets/local-github-org-contosodev-repos-token",
    "description": "Classic contoso-d",
    "teamAllMembers": "1944235",
    "preventLargeTeamPermissions": true,
    "teamAllReposRead": "2275189",
    "teamAllReposWrite": "2275190",
    "teamAllReposAdmin": "2279870",
    "templates": ["mit", "dnfmit"]
  }
]

Merged.