-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
20 changed files
with
228 additions
and
9 deletions.
There are no files selected for viewing
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
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
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,179 @@ | ||
| = Asdf | ||
| :tool_id: asdf | ||
| :tool_name: asdf | ||
| :tool_env_var: ASDF | ||
| :tool_tap: repository | ||
| :tool_tap_name: asdf-duke | ||
| :tool_manifest: plugin | ||
| :tool_package: ${distribution.name} | ||
|
|
||
| link:https://asdf-vm.com/[asdf] is a tool version manager. | ||
|
|
||
| The following artifact extensions are supported by this packager: | ||
|
|
||
| * `.tgz` | ||
| * `.txz` | ||
| * `.tar.gz` | ||
| * `.tar.xz` | ||
| * `.tar` | ||
| * `.zip` | ||
| NOTE: Default templates for `asdf` assume the project relies on xref:configuration:project.adoc#_semver[Semantic Versioning]. You'll have | ||
| to adjust the templates or provide your own if your project follows a different versioning scheme. | ||
|
|
||
| WARNING: Publication of snapshots is *not* allowed. | ||
|
|
||
| include::partial$legend.adoc[] | ||
|
|
||
| [tabs] | ||
| ==== | ||
| YAML:: | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$packagers/yaml/common-head.adoc[] | ||
| include::partial$packagers/yaml/template-directory.adoc[] | ||
| include::partial$packagers/yaml/commitauthor.adoc[] | ||
| include::partial$packagers/yaml/tap.adoc[] | ||
| # Tool verification command. | ||
| # Defaults to `{{distributionExecutable}} --version`. | ||
| # icon:dot-circle[] icon:file-alt[] | ||
| toolCheck: '{{distributionExecutable}} --version' | ||
| ---- | ||
| -- | ||
| TOML:: | ||
| + | ||
| -- | ||
| [source,toml] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$packagers/toml/common-head.adoc[] | ||
| include::partial$packagers/toml/template-directory.adoc[] | ||
| include::partial$packagers/toml/commitauthor.adoc[] | ||
| include::partial$packagers/toml/tap.adoc[] | ||
| # Tool verification command. | ||
| # Defaults to `{{distributionExecutable}} --version`. | ||
| # icon:dot-circle[] icon:file-alt[] | ||
| toolCheck = "{{distributionExecutable}} --version" | ||
| ---- | ||
| -- | ||
| JSON:: | ||
| + | ||
| -- | ||
| [source,json] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$packagers/json/common-head.adoc[] | ||
| include::partial$packagers/json/template-directory.adoc[] | ||
| include::partial$packagers/json/commitauthor.adoc[] | ||
| include::partial$packagers/json/tap.adoc[] | ||
| // Tool verification command. | ||
| // Defaults to `{{distributionExecutable}} --version`. | ||
| // icon:dot-circle[] icon:file-alt[] | ||
| "toolCheck": "{{distributionExecutable}} --version" | ||
| include::partial$packagers/json/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| Maven:: | ||
| + | ||
| -- | ||
| [source,xml] | ||
| [subs="attributes,verbatim,+macros"] | ||
| ---- | ||
| include::partial$packagers/maven/common-head.adoc[] | ||
| include::partial$packagers/maven/template-directory.adoc[] | ||
| include::partial$packagers/maven/commitauthor.adoc[] | ||
| include::partial$packagers/maven/tap.adoc[] | ||
| <!-- | ||
| Tool verification command. | ||
| Defaults to `{{distributionExecutable}} --version`. | ||
| icon:dot-circle[] icon:file-alt[] | ||
| --> | ||
| <toolCheck>{{distributionExecutable}} --version</toolCheck> | ||
| include::partial$packagers/maven/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| Gradle:: | ||
| + | ||
| -- | ||
| [source,groovy] | ||
| [subs="attributes,+macros"] | ||
| ---- | ||
| include::partial$packagers/gradle/common-head.adoc[] | ||
| include::partial$packagers/gradle/template-directory.adoc[] | ||
| include::partial$packagers/gradle/commitauthor.adoc[] | ||
| include::partial$packagers/gradle/tap.adoc[] | ||
| // Tool verification command. | ||
| // Defaults to `{{distributionExecutable}} --version`. | ||
| // icon:dot-circle[] icon:file-alt[] | ||
| toolCheck = '{{distributionExecutable}} --version' | ||
| include::partial$packagers/gradle/common-footer.adoc[] | ||
| ---- | ||
| -- | ||
| ==== | ||
|
|
||
| include::partial$packagers/token.adoc[] | ||
|
|
||
| include::partial$packagers/downloadUrl.adoc[] | ||
|
|
||
| == Skip Artifacts | ||
|
|
||
| If there is more than one matching artifact in a given distribution you may add a `skipAsdf` extra property to the target | ||
| artifact to mark it as skipped for packaging with asdf. | ||
|
|
||
| == Templates | ||
|
|
||
| The default location for templates is: | ||
|
|
||
| `src/jreleaser/distributions/<distribution-name>/asdf` | ||
|
|
||
| The following list shows the filenames that may be used to override default templates: | ||
|
|
||
| * `.github/workflows/build.yml.tpl` | ||
| * `bin/download.tpl` | ||
| * `bin/install.tpl` | ||
| * `bin/list-all.tpl` | ||
| * `lib/utils.bash.tpl` | ||
| * `README.md.tpl` | ||
| * `README-github.md.tpl` | ||
|
|
||
| Any additional files found in the template directories will be copied as is unless their filename ends with `.tpl` in | ||
| which case xref:name-templates.adoc[] substitution will take place. | ||
|
|
||
| Templates may be initialized using the `template` command | ||
|
|
||
| xref:tools:jreleaser-cli.adoc#_template[{icon_cli_s} template], | ||
| xref:tools:jreleaser-maven.adoc#_jreleasertemplate[{icon_maven_s} jreleaser:template], | ||
| xref:tools:jreleaser-gradle.adoc#_jreleasertemplate[{icon_gradle_s} jreleaserTemplate], | ||
| xref:tools:jreleaser-ant.adoc#_jreleaser_template[{icon_ant_s} jreleaser-template] | ||
|
|
||
| == Skip Templates | ||
|
|
||
| You may skip any template files by defining a set of skip rules in the `skipTemplates` property. For example, you may use | ||
| any of these expressions to skip a template named `README.md.tpl`: | ||
|
|
||
| * `README.md.tpl`: matches the full template name | ||
| * `README.md`: matches the transformed template name | ||
| * `README.*`: matches using a regex |
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
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
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