Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[code-owners] Add area information to code owner entries #205143

Merged
merged 2 commits into from
Dec 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/kbn-code-owners/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,9 @@ export {
findCodeOwnersEntryForPath,
getOwningTeamsForPath,
} from './src/code_owners';
export {
type CodeOwnerArea,
CODE_OWNER_AREAS,
CODE_OWNER_AREA_MAPPINGS,
findAreaForCodeOwner,
} from './src/code_owner_areas';
1 change: 1 addition & 0 deletions packages/kbn-code-owners/src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export async function findCodeOwnersForPath() {

log.write(`Matching pattern: ${codeOwnersEntry.pattern}`);
log.write('Teams:', codeOwnersEntry.teams);
log.write('Areas:', codeOwnersEntry.areas);
},
{
description: `Find code owners for a given path in this local Kibana repository`,
Expand Down
98 changes: 98 additions & 0 deletions packages/kbn-code-owners/src/code_owner_areas.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the "Elastic License
* 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/

/**
* Code owner area names
*/
export const CODE_OWNER_AREAS = ['platform', 'search', 'observability', 'security'] as const;
export type CodeOwnerArea = (typeof CODE_OWNER_AREAS)[number];

/**
* Area mappings for code owners
*/
export const CODE_OWNER_AREA_MAPPINGS: { [area in CodeOwnerArea]: string[] } = {
platform: [
'elastic/appex-ai-infra',
'elastic/appex-qa',
'elastic/appex-sharedux',
'elastic/docs',
'elastic/eui-team',
'elastic/kibana-cloud-security-posture',
'elastic/kibana-core',
'elastic/kibana-data-discovery',
'elastic/kibana-design',
'elastic/kibana-esql',
'elastic/kibana-localization',
'elastic/kibana-management',
'elastic/kibana-operations',
'elastic/kibana-performance-testing',
'elastic/kibana-presentation',
'elastic/kibana-qa',
'elastic/kibana-reporting-services',
'elastic/kibana-security',
'elastic/kibana-tech-leads',
'elastic/kibana-visualizations',
'elastic/logstash',
'elastic/ml-ui',
'elastic/platform-docs',
'elastic/response-ops',
'elastic/stack-monitoring',
'elastic/streams-program-team',
],
search: ['elastic/search-design', 'elastic/search-kibana'],
observability: [
'elastic/fleet',
'elastic/obs-ai-assistant',
'elastic/obs-cloudnative-monitoring',
'elastic/obs-docs',
'elastic/obs-entities',
'elastic/obs-knowledge-team',
'elastic/obs-ux-infra_services-team',
'elastic/obs-ux-logs-team',
'elastic/obs-ux-management-team',
'elastic/obs-ux-onboarding-team',
'elastic/observability-design',
'elastic/observability-ui',
'elastic/observablt-robots',
],
security: [
'elastic/security-asset-management',
'elastic/security-data-analytics',
'elastic/security-defend-workflows',
'elastic/security-design',
'elastic/security-detection-engine',
'elastic/security-detection-rule-management',
'elastic/security-detections-response',
'elastic/security-engineering-productivity',
'elastic/security-entity-analytics',
'elastic/security-generative-ai',
'elastic/security-scalability',
'elastic/security-service-integrations',
'elastic/security-solution',
'elastic/security-threat-hunting',
'elastic/security-threat-hunting-explore',
'elastic/security-threat-hunting-investigations',
],
};

/**
* Find what area a code owner belongs to
*
* @param owner Owner to find an area name
* @returns The code owner area if a match for the given owner is found
*/
export function findAreaForCodeOwner(owner: string): CodeOwnerArea | undefined {
for (const area of CODE_OWNER_AREAS) {
const owners = CODE_OWNER_AREA_MAPPINGS[area];

if (owners.includes(owner)) {
return area;
}
}
}
16 changes: 14 additions & 2 deletions packages/kbn-code-owners/src/code_owners.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ import path from 'node:path';

import ignore, { Ignore } from 'ignore';
import { CODE_OWNERS_FILE, throwIfPathIsMissing, throwIfPathNotInRepo } from './path';
import { CodeOwnerArea, findAreaForCodeOwner } from './code_owner_areas';

export interface CodeOwnersEntry {
pattern: string;
matcher: Ignore;
teams: string[];
areas: CodeOwnerArea[];
comment?: string;
}

Expand Down Expand Up @@ -64,9 +66,19 @@ export function getCodeOwnersEntries(): CodeOwnersEntry[] {

const pathPattern = rawPathPattern.replace(/\/$/, '');

const teams = rawTeams.map((team) => team.replace('@', '')).filter((team) => team.length > 0);
const areas: CodeOwnerArea[] = [];

for (const team of teams) {
const area = findAreaForCodeOwner(team);
if (area === undefined || areas.includes(area)) continue;
areas.push(area);
}

entries.push({
pattern: pathPattern,
teams: rawTeams.map((t) => t.replace('@', '')).filter((t) => t.length > 0),
teams,
areas,
comment,

// Register code owner entry with the `ignores` lib for easy pattern matching later on
Expand All @@ -85,7 +97,7 @@ export function getCodeOwnersEntries(): CodeOwnersEntry[] {
*
* Tip:
* If you're making a lot of calls to this function, fetch the code owner paths once using
* `getCodeOwnersEntries` and pass it in the `getCodeOwnersEntries` parameter to speed up your queries..
* `getCodeOwnersEntries` and pass it in the `getCodeOwnersEntries` parameter to speed up your queries.
*
* @param searchPath The path to find code owners for
* @param codeOwnersEntries Pre-defined list of code owner paths to search in
Expand Down