netlify:upload
Full name:
io.earcam.maven.plugin:io.earcam.maven.plugin.netlify:0.0.4:upload
Description:
Netlify site deploy plugin
Attributes:
- Requires a Maven project to be executed.
- Binds by default to the lifecycle phase: site-deploy.
- Is NOT inherited by default in multi-project builds.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <serverId> | String | - | Server ID, references a <server> in your ~/.m2/settings.xml, where your <password> is your Netlify access token (generate via Netlify ⇒ Account Settings ⇒ OAuth applications ⇒ Personal access tokens) User property is: deploy.netlify.server.id. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <createSiteIfNotExists> | boolean | - | Fails build if site (as identified by <siteName>) does not already exist and this property is set to false Default value is: true. User property is: deploy.netlify.site.create. |
| <customDomain> | String | - | Configure a custom domain, e.g. given <siteName>foo.acme.com</siteName> configure a DNS CNAME entry for your subdomain foo.acme.com to point to acme-foo.netlify.com. and set this to <customDomain>foo.acme.com</customDomain> User property is: deploy.netlify.domain.custom. |
| <siteName> | String | - | The unique site name, used as a Netlify identifier and subdomain, e.g. given <siteName>foo</siteName>, then URL == //foo.netlify.com User property is: deploy.netlify.site.name. |
| <skip> | boolean | - | Skip execution of this plugin Default value is: false. User property is: deploy.netlify.skip. |
Parameter Details
<createSiteIfNotExists>
Fails build if site (as identified by
<siteName>) does not already exist and this property is set to
false
- Type: boolean
- Required: No
- User Property: deploy.netlify.site.create
- Default: true
<customDomain>
Configure a custom domain, e.g. given
<siteName>foo.acme.com</siteName> configure a DNS CNAME entry for your subdomain
foo.acme.com to point to
acme-foo.netlify.com. and set this to
<customDomain>foo.acme.com</customDomain>
- Type: java.lang.String
- Required: No
- User Property: deploy.netlify.domain.custom
<serverId>
Server ID, references a
<server> in your
~/.m2/settings.xml, where your
<password> is your Netlify access token (generate via Netlify ⇒ Account Settings ⇒ OAuth applications ⇒ Personal access tokens)
- Type: java.lang.String
- Required: Yes
- User Property: deploy.netlify.server.id
<siteName>
The unique site name, used as a Netlify identifier and subdomain, e.g. given
<siteName>foo</siteName>, then
URL == //foo.netlify.com
- Type: java.lang.String
- Required: No
- User Property: deploy.netlify.site.name
<skip>
Skip execution of this plugin
- Type: boolean
- Required: No
- User Property: deploy.netlify.skip
- Default: false