Document

Git source and required files

Connect Git providers, select a source and provide files Boilerplate can recognize.

Git integrations

Products are added through GitHub, GitLab or Bitbucket integrations. Authorize Boilerplate, select the repository, then continue to branch, tag and file selection.

Choose the provider that already hosts the component. If the repository is private, make sure the connected Git account has access before starting the add-product flow. Repository visibility problems usually show up later as missing branches, missing tags or an unavailable source.

Selecting source files

Choose repository, branch or tag, programming language, product type, files or folders and required agreements. The selected source should represent one recognizable component. For archive-based uploads from Git tags or releases, supported formats can include .tar, .tar.gz, .tgz, .ear, .war and .jar, depending on the selected product type and platform rules.

Minimal required files

Project typeRequired or expected files
GradleBuild and settings files, optional gradle.properties, and JVM source files.
Mavenpom.xml and JVM source files.
npmpackage.json, optional package-lock.json, and JavaScript or TypeScript files.
Yarnpackage.json, yarn.lock, and JavaScript or TypeScript files.
pnpmpackage.json, pnpm-lock.yaml, and JavaScript or TypeScript files.
Binary or otherboilerplate.yml or boilerplate.yaml with required metadata.

Monorepositories are not supported as a single component upload in the described flow. Split or select a project structure that Boilerplate can validate as one product with its own metadata files.

What Store reads from source

Source selection gives Store enough information to build a product candidate: repository provider, repository ID, branch or tag, selected files, language, package manager and product type. Dependency metadata is read from recognized files such as package.json, lockfiles, pom.xml or Gradle files. Archive uploads still need enough metadata for Store to decide what the product is and how buyers should consume it.