Release Assets
The releaseAssets element is the list of artifacts that have been actually published along with the release. For each asset you have the file name, the description (or label), the MIME type and the URL to download the published asset.
The assets being published are the ones configured by means of the releaseAssets configuration with a couple of details to keep in mind:
- each release type may use the global definition of release assets (by default) or just a subset of assets (in case it defines the
assetsoption) - publication services may offer different support or have limitations for release assets. Please check the services page for details
This list is only populated when newRelease is true and only after publish has run.
Following is the list of attributes for each published asset.
Release asset attributes
The following attributes are children of each item in the releaseAssets list:
| Name | Type | Values |
|---|---|---|
releaseAssets/<#>/description | string | The (short) description (or label) of the published asset |
releaseAssets/<#>/fileName | string | The name of the published asset |
releaseAssets/<#>/path | string | The URL of the published asset |
releaseAssets/<#>/type | string | The MIME type of the published asset |
Description
| Name | releaseAssets/<#>/description |
| Type | string |
| Related configuration options | |
| Initialized by task |
The short description of the asset, or its label, depending on the semantics used by the publication service.
Unless the publication service has a custom treatment for this attribute, this is the same of the configured asset description. If the configured value is a template, this value is the outcome of rendering the source.
File name
| Name | releaseAssets/<#>/fileName |
| Type | string |
| Related configuration options | |
| Initialized by task |
The name of the file, or simply the short name of the asset, that has been published.
Unless the publication service has a custom treatment for this attribute, this is the same of the configured asset file name. If the configured value is a template, this value is the outcome of rendering the source.
Path
| Name | releaseAssets/<#>/path |
| Type | string |
| Related configuration options | |
| Initialized by task |
The URL that the asset is available to. This URL can be used to download the asset once it's published.
When the configured asset is a local file, this URL is generated and assigned by the publication service once the asset has been uploaded. Otherwise, if the configured asset is a remote URL this should be the same as the configured value.
Type
| Name | releaseAssets/<#>/type |
| Type | string |
| Related configuration options | |
| Initialized by task |
The MIME type of the asset.
Unless the publication service has a custom treatment for this attribute, this is the same of the configured asset file name. If the configured value is a template, this value is the outcome of rendering the source.