build.ts

/*
 * 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 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 or the Server
 * Side Public License, v 1.
 */

import { bkEnv } from './buildkite';

interface Job {
  name: string;
  id: string;
}

interface BuildConfig {
  jobs: Job[];
}

/**
 * This config enabled updating of required check runs when build is skipped
 */
export const getBuildConfig = (): BuildConfig => {
  return {
    jobs: [
      { name: 'Types', id: 'types' },
      { name: 'API', id: 'api' },
      { name: 'Build - Docs', id: 'build_docs' },
      { name: 'Build - e2e server', id: 'build_e2e' },
      { name: 'Build - Storybook', id: 'build_storybook' },
      ...(bkEnv.isPullRequest ? [{ name: 'Build - @elastic/charts package', id: 'build_charts_package_preview' }] : []),
      { name: 'Pre Deploy - firebase', id: 'pre_deploy_fb' },
      { name: 'Eslint', id: 'eslint' },
      { name: 'Prettier', id: 'prettier' },
      { name: 'Deploy - firebase', id: 'deploy_fb' },
      // ...(bkEnv.isMainBranch ? [{ name: 'Deploy - GitHub Pages', id: 'deploy_ghp' }] : []),
      { name: 'Jest', id: 'jest' },
      { name: 'Playwright e2e VRT', id: 'playwright_vrt' },
      { name: 'Playwright e2e A11Y', id: 'playwright_a11y' },
    ],
  };
};

export const getJobCheckName = (checkId: string) => {
  const { jobs } = getBuildConfig();
  const job = jobs.find(({ id }) => id === checkId);

  if (!job) {
    throw new Error(`Failed to find check name from step id ${checkId}. Job ids are:\n\n\t${jobs.join('\n\t')}`);
  }
  return job.name;
};