Skip to main content

Package

Creating a package

php meteor.phar package

View a recording of a package being created:

The output directory will default to ./output and the filename will be generated from the name and version configuration. For example if the name of your package is jadu/test and have a version file containing 1.0.0 then your package will be named jadu_test_1.0.0. The ZIP archive will contain a directory called jadu_test_1.0.0.

A different output directory can be specified:

php meteor.phar package --output-dir=packages

A different package filename can be specified:

php meteor.phar package --filename=test_package

A package name must begin with a letter or number and can contain only letters, numbers, hyphens, underscores and dots. If an invalid package filename is provided then Meteor will ignore the option and use the default filename.

Configuration

{
"package": {
"files": [
"/**"
],
"version": "VERSION",
"combine": {
"jadu/cms": "15.0.0"
}
}
}

files (optional)

The files parameter is a list of paths to include within the package.

Paths can also be excluded from the package by prefixing the path with an !, for example !/composer.json will exclude /composer.json from the package.

version (optional)

The version parameter specifies the name of the file containing the version information for this package.

combine (optional)

The combine parameter is a list of required packages and corresponding versions.

provider (optional)

The provider parameter specifies how to fetch packages to combine automatically if not passed via the --combine option.

Available providers:

  • gdrive (available with the GoogleDrivePackageProvider extension)

Combining packages

When building a package multiple packages can be combined with it so that only a single patch needs to be applied.

php meteor.phar package --combine=cms.zip --combine=module.zip

In the above example all of the required files and migrations from cms.zip and module.zip will be included in the package.

If a package provider has been configured then the --combine options can be omitted and the relevant package will be downloaded automatically.

php meteor.phar package