Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
40 changed files
with
2,371 additions
and
55 deletions.
There are no files selected for viewing
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| = Deploy | ||
|
|
||
| Artifacts may be deployed to configured locations. | ||
|
|
||
| include::partial$legend.adoc[] | ||
|
|
||
| [tabs] | ||
| ==== | ||
| YAML:: | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| [subs="+macros"] | ||
| ---- | ||
| # icon:dot-circle[] | ||
| deploy: | ||
| # Enable or disable all configured deployers. | ||
| # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`]. | ||
| # Defaults to `ALWAYS`. | ||
| # icon:dot-circle[] | ||
| active: ALWAYS | ||
| ---- | ||
| -- | ||
| TOML:: | ||
| + | ||
| -- | ||
| [source,toml] | ||
| [subs="+macros"] | ||
| ---- | ||
| # icon:dot-circle[] | ||
| [deploy] | ||
| # Enable or disable all configured deployers. | ||
| # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`]. | ||
| # Defaults to `ALWAYS`. | ||
| # icon:dot-circle[] | ||
| active = "ALWAYS" | ||
| ---- | ||
| -- | ||
| JSON:: | ||
| + | ||
| -- | ||
| [source,json] | ||
| [subs="+macros"] | ||
| ---- | ||
| { | ||
| // icon:dot-circle[] | ||
| "deploy": { | ||
| // Enable or disable all configured deployers. | ||
| // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`]. | ||
| // Defaults to `ALWAYS`. | ||
| // icon:dot-circle[] | ||
| "active": "ALWAYS" | ||
| } | ||
| } | ||
| ---- | ||
| -- | ||
| Maven:: | ||
| + | ||
| -- | ||
| [source,xml] | ||
| [subs="verbatim,+macros"] | ||
| ---- | ||
| <jreleaser> | ||
| <!-- | ||
| icon:dot-circle[] | ||
| --> | ||
| <deploy> | ||
| <!-- | ||
| Enable or disable all configured deployers. | ||
| Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`]. | ||
| Defaults to `ALWAYS`. | ||
| icon:dot-circle[] | ||
| --> | ||
| <active>ALWAYS</active> | ||
| </deploy> | ||
| </jreleaser> | ||
| ---- | ||
| -- | ||
| Gradle:: | ||
| + | ||
| -- | ||
| [source,groovy] | ||
| [subs="+macros"] | ||
| ---- | ||
| jreleaser { | ||
| // icon:dot-circle[] | ||
| deploy { | ||
| // Enable or disable all configured deployers. | ||
| // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`]. | ||
| // Defaults to `ALWAYS`. | ||
| // icon:dot-circle[] | ||
| active = 'ALWAYS' | ||
| } | ||
| } | ||
| ---- | ||
| -- | ||
| ==== | ||
|
|
||
| NOTE: When not explicitly set, the value of `active` may be resolved from an environment variable `JRELEASER_DEPLOY_ACTIVE` | ||
| or from a system property `jreleaser.deploy.active`. The system property takes precedence over the environment variable. |
205 changes: 205 additions & 0 deletions
205
docs/modules/configuration/pages/deploy/maven/artifactory.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| = Artifactory | ||
| :deployer_id: artifactory | ||
| :deployer_name: Artifactory | ||
| :prefix: ARTIFACTORY | ||
| :deployer_url: https://duke.jfrog.io/artifactory/maven | ||
| :default_auth: BEARER | ||
|
|
||
| Deploys staged artifacts to link:https://jfrog.com/artifactory/[JFrog {deployer_name}] instance. | ||
|
|
||
| .Prerequisites: | ||
|
|
||
| * A running Artifactory instance. | ||
| * A user + password / token with grants to deploy an artifact. | ||
|
|
||
| IMPORTANT: This feature *does not* support deploying artifacts other than JARs and POMs to a Maven compatible repository. | ||
| If you need to upload any other binaries then check the xref:configuration:upload/{deployer_id}.adoc[{deployer_name} Uploader]. | ||
|
|
||
| include::partial$legend.adoc[] | ||
|
|
||
| [tabs] | ||
| ==== | ||
| YAML:: | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$deploy/maven/yaml/common-head.adoc[] | ||
| ---- | ||
| -- | ||
| TOML:: | ||
| + | ||
| -- | ||
| [source,toml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$deploy/maven/toml/common-head.adoc[] | ||
| ---- | ||
| -- | ||
| JSON:: | ||
| + | ||
| -- | ||
| [source,json] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$deploy/maven/json/common-head.adoc[] | ||
| include::partial$deploy/maven/json/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| Maven:: | ||
| + | ||
| -- | ||
| [source,xml] | ||
| [subs="attributes,verbatim,+macros"] | ||
| ---- | ||
| include::partial$deploy/maven/maven/common-head.adoc[] | ||
| include::partial$deploy/maven/maven/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| Gradle:: | ||
| + | ||
| -- | ||
| [source,groovy] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$deploy/maven/gradle/common-head.adoc[] | ||
| include::partial$deploy/maven/gradle/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| ==== | ||
|
|
||
| == Url | ||
|
|
||
| You may set the url in the configuration as shown above, or you can have it read from an environment variable. | ||
| The configured name of the {deployer_name} instance will be used to build the environment variable name. | ||
| This means that the name per configured instance needs to be unique. | ||
|
|
||
| The name of the environment variable will be `JRELEASER_{prefix}_NAME_URL`. If your instance is named `production`, | ||
| you can store the host in the environment variable `JRELEASER_{prefix}_PRODUCTION_URL`. The name will be | ||
| transformed to uppercase. | ||
|
|
||
| == Username | ||
|
|
||
| The configured username needs to be authenticated against the {deployer_name} instance. | ||
|
|
||
| You may set the username set in the configuration as shown above, or you can have it read from an environment variable. | ||
| The configured name of the {deployer_name} instance will be used to build the environment variable name. | ||
| This means that the name per configured instance needs to be unique. | ||
|
|
||
| The name of the environment variable will be `JRELEASER_{prefix}_NAME_USERNAME`. If your instance is named `production`, | ||
| you can store the username in the environment variable `JRELEASER_{prefix}_PRODUCTION_USERNAME`. The name will be | ||
| transformed to uppercase. | ||
|
|
||
| If a configured username is found in the configuration file, then the environment variable is not used at all. | ||
|
|
||
| == Password | ||
|
|
||
| The password will be stored in an environment variable. The configured name of the {deployer_name} instance will | ||
| be used. This means that the name per configured instance needs to be unique. | ||
|
|
||
| The name of the environment variable will be `JRELEASER_{prefix}_NAME_PASSWORD`. If your instance is named `production`, | ||
| you need to store the secret in the environment variable `JRELEASER_{prefix}_PRODUCTION_PASSWORD`. The name will be | ||
| transformed to uppercase. | ||
|
|
||
| == Example | ||
|
|
||
| [tabs] | ||
| ==== | ||
| YAML:: | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| deploy: | ||
| maven: | ||
| {deployer_id}: | ||
| app: | ||
| active: always | ||
| url: {deployer_url} | ||
| stagingRepositories: | ||
| - target/staging-deploy | ||
| ---- | ||
| -- | ||
| TOML:: | ||
| + | ||
| -- | ||
| [source,toml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| [deploy.maven.{deployer_id}.app] | ||
| active = "ALWAYS" | ||
| host = "{deployer_url}" | ||
| stagingRepositories = ["target/staging-deploy"] | ||
| ---- | ||
| -- | ||
| JSON:: | ||
| + | ||
| -- | ||
| [source,json] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| { | ||
| "jreleaser": { | ||
| "deploy": { | ||
| "maven": { | ||
| "{deployer_id}": { | ||
| "app": { | ||
| "active": "ALWAYS", | ||
| "host": "{deployer_url}", | ||
| "stagingRepositories": [ | ||
| "target/staging-deploy" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ---- | ||
| -- | ||
| Maven:: | ||
| + | ||
| -- | ||
| [source,xml] | ||
| [subs="attributes,verbatim,+macros"] | ||
| ---- | ||
| <jreleaser> | ||
| <deploy> | ||
| <maven> | ||
| <{deployer_id}> | ||
| <app> | ||
| <active>ALWAYS</active> | ||
| <host>{deployer_url}</host> | ||
| <stagingRepositories>target/staging-deploy</stagingRepositories> | ||
| </app> | ||
| </{deployer_id}> | ||
| </maven> | ||
| </deploy> | ||
| </jreleaser> | ||
| ---- | ||
| -- | ||
| Gradle:: | ||
| + | ||
| -- | ||
| [source,groovy] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| jreleaser { | ||
| deploy { | ||
| maven { | ||
| {deployer_id} { | ||
| app { | ||
| active = 'ALWAYS' | ||
| host = '{deployer_url}' | ||
| stagingRepository('target/staging-deploy') | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ---- | ||
| -- | ||
| ==== |
Oops, something went wrong.