KC's Workspace
    Preparing search index...

    Interface JobSummaryOptions

    interface JobSummaryOptions {
        enabled: boolean;
        fileLinks: {
            commitHash?: string;
            repository?: string;
            workspacePath?: string;
        };
        outputPath: string
        | undefined;
    }
    Index

    Properties

    enabled fileLinks outputPath

    Properties

    enabled: boolean

    Whether to generate the summary.

    true
    fileLinks: { commitHash?: string; repository?: string; workspacePath?: string }

    Configuration for generating permalink URLs to source files in the GitHub repository.

    When all three values are available (either from this config or the defaults picked from environment variables), test names in the summary will link to the relevant source lines.

    Type Declaration

    • OptionalcommitHash?: string

      The commit SHA to use in permalink URLs.

      process.env.GITHUB_SHA
    • Optionalrepository?: string

      The GitHub repository in owner/repo format.

      process.env.GITHUB_REPOSITORY
    • OptionalworkspacePath?: string

      The absolute path to the root of the repository on disk.

      This value is used to compute relative file paths for the permalink URLs.

      process.env.GITHUB_WORKSPACE
    outputPath: string | undefined

    File path to write the summary to.

    process.env.GITHUB_STEP_SUMMARY

    Settings

    Member Visibility

    On This Page

    Properties