Skip to content

Commit

Permalink
Document jreleaser/jreleaser#961
Browse files Browse the repository at this point in the history
  • Loading branch information
@aalmiray
aalmiray committed Sep 19, 2022
1 parent ce33824 commit 637c079
Showing 1 changed file with 31 additions and 15 deletions.
46 changes: 31 additions & 15 deletions docs/modules/configuration/pages/name-templates.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,47 @@ The following functions may be used to modify text:
[%header, cols="<2,<5", width="100%"]
|===
| Key | Description
| f_now | formats the current timestamp
| f_trim | removes whitespace from the input
| f_underscores | transforms `.` and `-` into `_`
| f_dash | transforms `.` and `_` into `-`
| f_slash | transforms `.` and `-` into `/`
| f_upper | invokes `toUpperCase()`
| f_lower | invokes `toLowerCase()`
| f_capitalize | invokes `capitalize()`
| f_uncapitalize | invokes `uncapitalize()`
| f_release_download_url | formats its input as a link to a release asset
| f_md2html | transforms its input from Markdown into HTML
| f_json | converts the given input into JSON
| f_file_read | reads a file and includes its contents, verbatim
| f_file_size | the size of the file, in bytes
| f_checksum_md2 | file checksum with the given algorithm
| f_checksum_md5 | file checksum with the given algorithm
| f_checksum_rmd160 | file checksum with the given algorithm
| f_checksum_sha1 | file checksum with the given algorithm
| f_checksum_sha256 | file checksum with the given algorithm
| f_checksum_sha384 | file checksum with the given algorithm
| f_checksum_sha512 | file checksum with the given algorithm
| f_checksum_sha3-224 | file checksum with the given algorithm
| f_checksum_sha3-256 | file checksum with the given algorithm
| f_checksum_sha3-384 | file checksum with the given algorithm
| f_checksum_sha3-512 | file checksum with the given algorithm
| f_checksum_sha384 | file checksum with the given algorithm
| f_checksum_sha512 | file checksum with the given algorithm
| f_chop | remove the last character from a String
| f_dash | transforms `.` and `_` into `-`
| f_delete_whitespace | deletes all whitespaces from a String
| f_escape_csv | returns a String value for a CSV column enclosed in double quotes, if required
| f_escape_ecma_script | escapes the characters in a String using EcmaScript String rules
| f_escape_html3 | escapes the characters in a String using HTML entities
| f_escape_html4 | escapes the characters in a String using HTML entities
| f_escape_java | escapes the characters in a String using Java String rules
| f_escape_json | escapes the characters in a String using Json String rules
| f_escape_xml10 | escapes the characters in a String using XML entities
| f_escape_xml11 | escapes the characters in a String using XML entities
| f_escape_xsi | escapes the characters in a String using XSI rules
| f_file_read | reads a file and includes its contents, verbatim
| f_file_size | the size of the file, in bytes
| f_json | converts the given input into JSON
| f_lower | invokes `toLowerCase()`
| f_md2html | transforms its input from Markdown into HTML
| f_normalize_whitespace | similar to xpath/#function-normalize-space
| f_now | formats the current timestamp
| f_recursive_eval | evaluates templates found in the input
| f_release_download_url | formats its input as a link to a release asset
| f_reverse | reverses a String
| f_slash | transforms `.` and `-` into `/`
| f_strip | strips whitespace from the start and end of a String
| f_swapcase | swaps the case of a String changing upper and title case to lower case, and lower case to upper case
| f_trim | removes whitespace from the input
| f_uncapitalize | invokes `uncapitalize()`
| f_underscores | transforms `.` and `-` into `_`
| f_upper | invokes `toUpperCase()`
|===

The `f_release_download_url` function expects the name of a release asset and creates a link to said asset. The default
Expand Down

0 comments on commit 637c079

Please sign in to comment.