Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.24 KB

providers.md

File metadata and controls

70 lines (52 loc) · 2.24 KB

Providers

This Provider enables the delivery of Frontend assets over an HTTP resource. The downloaded assets are stored in a temporary directory from where they can be processed further. The Provider also requests the revision of the requested assets and adds them to the requested source.

It supports no additional configuration.

With this Provider, local paths may be used as Frontend asset source. An additional command can be specified that is executed prior to validating the local path, e.g. to initialize a new build or archive a list of files and directories.

Note

The local path itself is configured by the url configuration.

It supports the following additional configuration:

command

A custom command that is locally executed prior to validating the source file. By default, the source path – as specified in the url section – will be taken for further processing with a supported processor. However, if you first need to prepare such a file or directory, you may define an additional custom command here.

  • Required: no
  • Default:

It may contain placeholders in the form {<config key>} that are replaced by source configuration values. e.g. {environment}. In addition, it supports the following special placeholders:

  • {cwd} is replaced by the current working directory
  • {url} is replaced by the resolved source path (url)

url

In addition to the default configuration, it may contain the following special placeholders:

  • {cwd} is replaced by the current working directory
  • {temp} is replaced by a temporary filename (must be at the beginning of the path, e.g. {temp}.tar.gz)

Example configuration:

{
    "frontend-assets": [
        {
            "source": {
                "type": "local",
                "command": "tar -czvf '{url}' -C '{cwd}/frontend' 'dist'",
                "url": "{temp}.tar.gz"
            },
            "target": {
                // ...
            }
        }
    ]
}

Warning

The resolved URL must be an existing path on the local filesystem.