ComposerRequire runs `composer require` with the given packages. It expects packages to be specified as `composer require` would expect them on the co

Contribute accepts a layer and transforms it, returning a layer.

DefaultStartCommand returns the default command that should be used to configure the application web process if the user has not explicitly configured

DetectAppHostingYAMLPath returns the absolute path to the apphosting.yaml file, or an error if no such file is found.

DetectFlutterSDKArchive detects which SDK version should be installed from the environment or fetches the latest stable available version. Returns ver

DetectSDKVersion detects which SDK version should be installed from the environment or fetches the latest stable available version.

DetectSvelteKitAutoAdapter returns true if the given package.json file contains the @sveltejs/adapter-auto dependency and no others.

Entrypoint retrieves the appropriate entrypoint command for the direct maker build.

ExitCode returns the exit code that the preparer/publisher should exit with.

ExtractAngularStartCommand inspects the given package.json file for an idiomatic `serve:ssr:APP_NAME` command. If one exists, its value is returned. I

ForEachCounter executes a function for each initialized Counter

ForEachValue iterates over all values in the BuilderMetadata.

FormatName takes in a language name and version and returns the GCF / GAE runtime name. For example, FormatRuntime("go", "1.16.0") returns "go116".

GenerateBuildDereferencedEnvMap will return a mapping of environment variables to their dereferenced secret values along with plain env vars only if t

GenerateYarnConfig adds auth token to .yarnrc.yml in the user's HOME directory necessary for Yarn to make authenticated requests to Artifact Registry

GetHostname returns the hostname for the TPC build.

GetInstallableRuntime returns the installable runtime prefix.

GetLatestGradleVersion gets the latest gradle version if available

GetSDKVersion returns the appropriate .NET SDK version to use, with the following heuristic: 1. Return value of env variable GOOGLE_DOTNET_SDK_VERSION

GetScriptCommand returns the script command from pyproject.toml if it exists.

GoModVersion reads the version of Go from a go.mod file if present. If not present or if version isn't there returns an empty string.

HasBuildRunner returns true if the given Dart project contains a pubspec.yaml that declares a dependency on build_runner.

InstallAndSymlink configures bundler, runs 'bundle install', and creates relative symlinks for gem binaries.

InstallAngularBuildAdapter installs the angular build adaptor in the given layer if it is not already cached.

InstallDartSDK downloads a given version of the dart SDK to the specified layer.

InstallFlutterSDK downloads a given version of the Flutter SDK to the specified layer.

InstallNextJsBuildAdapter installs the nextjs build adaptor in the given layer if it is not already cached.

InstallYarn downloads a given version of Yarn into the provided directory.

InstallYarnLayer installs Yarn in the given layer if it is not already cached.

InstalledRuntimeVersions returns the list of runtime versions installed during build time.

InvalidRootDirectoryError creates a FahError with metadata about a missing or invalid root directory that caused the build to fail.

IsAlphaSupported returns true if the release track is alpha.

IsDebugMode returns true if the buildpack debug mode is enabled.

IsGCP returns true if the buildpack target platform is not gae, gcf or flex.

IsReleaseCandidate returns true if given string is a RC candidate version.

IsUVRequirements checks if the application is a UV requirements.txt application.

MaybeMovePathContents moves the contents of srcPath to destPath.

MergeVpcAccess merges the access from the YAML settings and the output bundle (though the output bundle is not expected to have any VPC access setting

MergeWithEnvironmentSpecificYAML merges the environment specific apphosting.<environmentName>.yaml with the base apphosting schema found in apphosting

MissingLockFileError creates a FahError with metadata about a missing lock file for the user's package manager (npm, yarn, or pnpm).

NeedsRailsAssetPrecompile detects if asset precompilation is required in a Ruby on Rails app.

NeedsSupervisorPackage returns whether to install supervisor.

NewGoWorkspaceLayer returns a new layer for `go env GOPATH` or the go workspace. The layer is configured for caching if possible. It only supports cac

NewStructureTest creates a new StructureTest. It returns nil if there's nothing to check.

NginxVersionConstraint returns the Nginx version constraint for the specified runtime name. If the runtime name is not found in the map, it returns th

Normalize converts the different possible secret formats provided by users into one standard format of projects/p/secrets/s/versions/v.

NormalizeVpcAccess ensures that any connector is a fully qualified resource name.

NuxtStartCommand determines if this is a Nuxt application and returns the command to start the nuxt server. If not it is not a Nuxt application it ret

OverriddenProperties returns whether the property has been overridden and the path to the file.

Parse parses a Procfile content and returns a map of process names to commands. If multiple processes have the same name, only the first one is return

ParseAppEngineWebXML unmarshals the provided appengine-web.xml into a AppEngineWebXMLApp.

ParseBundlerVersion extacts the version of bundler from Gemfile.lock or gems.locked, returns an error in case the version string is malformed.

ParseEnvVarsFromString parses the server side environment variables from a string to a list of EnvironmentVariables.

ParseRubyVersion extracts the version number from Gemfile.lock or gems.locked, returns an error in case the version string is malformed.

PinGemAndBundlerVersion pins the RubyGems versions for GAE and GCF runtime versions to prevent unexpected behaviors with new versions. This is only ex

PinVersions will determine the latest version for any secrets that require it and pin it to that value for any subsequent steps. Requires that secrets

PipTargetDir returns the target directory for installing python dependencies.

Prepare performs pre-build logic for App Hosting backends including: * Reading, sanitizing, and writing user-defined environment variables in apphosti

PrepareLockfile configures bundler and ensures the target platforms are present in the lockfile.

Publish takes in the path to various required files such as apphosting.yaml, bundle.yaml, and other files (tbd) and merges them into one output that d

Publish restores, publishes, and determines the runtime entrypoint of the Dotnet application. If useLayer is true, it performs the publish steps using

ReadAndValidateFromFile converts the provided file into an BundleSchema.

ReadLifecycle reads the env vars from the given directory in a way that is compatible with the lifecycle build process.

ReadNxJSONIfExists returns deserialized nx.json from the given dir. If the provided dir does not contain a nx.json file it returns nil. Empty dir stri

ReadNxProjectJSONIfExists returns deserialized project.json from the given dir. If the provided dir does not contain a project.json file it returns ni

ReadRuntimeConfigJSON reads a given runtimeconfig.json file and returns a struct representation of the contents.

ReadTurboJSONIfExists returns deserialized turbo.json from the given dir. If the provided dir does not contain a turbo.json file it returns nil. Empty

RequestedNPMVersion returns any customer provided NPM version constraint configured in the "engines" section of the package.json file in the given app

RequestedPoetryVersion returns the requested poetry version from pyproject.toml.

RequestedUVVersion returns the requested uv version from pyproject.toml.

RequirementsPackagePresent checks if a given package is present in requirements.txt.

Reset resets the state of the metrics struct For testing use only.

RestoreModules restores node_modules from the cache layer.

RunDetectPhaseForTest runs a detect phase and reports the outcome.

Sanitize strips reserved environment variables from the environment variable list.

SaveModules saves node_modules to the cache layer.

SetEnvVariables sets the env variables necessary for configuring the overrides.

SetRunCommand sets the run command for the web process. The run command is set from the apphosting.yaml file if it exists, otherwise it is set from th

SetRunCommand sets the run command for the web process. The run command is set from the apphosting.yaml file if it exists, otherwise it is set from th

ShouldPrunePnpmBun returns true if dev dependencies should be pruned for pnpm/bun.

SkipSyntaxCheck returns true if we should skip checking the user's function file for syntax errors if it is impacted by https://github.com/GoogleCloud

SpringBootVersionInManifest returns the Spring Boot version in the manifest of the application JAR.

SupportsAutoVendor returns true if the Go version supports automatic detection of the vendor directory. This feature is supported by Go 1.14 and highe

SupportsNPMPrune returns true if the version of npm installed in the system supports the prune command.

SupportsSmartDefaultEntrypoint returns true if the runtime version supports smart default entrypoint.

SvelteKitStartCommand determines if this is a SvelteKit application and returns the command to start the SvelteKit server. If not it is not a SvelteKi

UnsupportedFrameworkVersionError creates a FahError with metadata about the unsupported framework version that caused the build to fail.

UpdateAppRunScript reads the run.template file, replaces {{ENTRYPOINT}} with the provided webCmd, populates the Runit envdir with exported environment

ValidateFlexMinVersion validates the minimum flex version for a given runtime.

ValidateVpcAccess validates the form of a vpcAccess struct.