@cdwr/nx-fly-deployment-action/src/lib/utils/get-app-name.d.ts

The Nx Fly Deployment Action will manage your deployments to fly.io.

import type { Environment } from '@codeware/core/actions';
type Options = {
    /** Deployment environment */
    environment: Environment;
    /** Fly config app name */
    configAppName: string;
    /** Pull request number */
    pullRequest?: number;
    /** Tenant ID when multi-tenancy is used */
    tenantId?: string;
};
/**
 * Get the name of the app.
 *
 * Preview apps should always get a name based on pull request numbers.
 *
 * E.g. `<config-app-name>-pr-<pull-request-number>`
 *
 * Compared to production apps: `<config-app-name>`.
 *
 * For tenant apps, add the tenant ID suffix to keep them separated
 * for the same base app name.
 *
 * E.g.
 * - `<config-app-name>-pr-<pull-request-number>-<tenant-id>`
 * - `<config-app-name>-<tenant-id>`
 *
 * @param options - Options
 * @returns The name of the app
 * @throws Error if pull request number is missing for preview environment
 */
export declare const getAppName: (options: Options) => string;
export {};