Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
aalmiray committed Mar 24, 2024
1 parent d796220 commit 1d2a4fe
Show file tree
Hide file tree
Showing 20 changed files with 246 additions and 7 deletions.
91 changes: 91 additions & 0 deletions docs/modules/reference/pages/announce/article.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,97 @@ include::partial$envvars-header.adoc[]
JRELEASER_CODEBERG_BRANCH_PUSH
|===

== Repository

The `repository` section allows setting extra properties that may be used to provide additional hints when interacting
with the git repository that holds article sources.

=== GitLab

Define a `projectIdentifier` property to directly locate the project associated with the repository, such as

[tabs]
====
YAML::
+
--
[source,yaml]
[subs="+macros,attributes"]
----
announce:
article:
repository:
extraProperties:
projectIdentifier: 12345678
----
--
TOML::
+
--
[source,toml]
[subs="+macros,attributes"]
----
[announce.article]
repository.extraProperties.projectIdentifier = "12345678"
----
--
JSON::
+
--
[source,json]
[subs="+macros,attributes"]
----
{
"announce": {
"article": {
"repository": {
"extraProperties": {
"projectIdentifier": "12345678"
}
}
}
}
}
----
--
Maven::
+
--
[source,xml]
[subs="+macros,attributes,verbatim"]
----
<jreleaser>
<announce>
<article>
<repository>
<extraProperties>
<projectIdentifier>12345678</projectIdentifier>
</extraProperties>
</repository>
</article>
</announce>
</jreleaser>
----
--
Gradle::
+
--
[source,groovy]
[subs="+macros,attributes"]
----
jreleaser {
announce {
article {
repository {
extraProperties.put("projectIdentifier", "12345678")
}
}
}
}
----
--
====

== Example

Given a project configured as
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/appimage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -697,3 +697,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/asdf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -223,3 +223,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/chocolatey.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -487,3 +487,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1157,3 +1157,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
3 changes: 2 additions & 1 deletion docs/modules/reference/pages/packagers/flatpak.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,6 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.
If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.


== Publication to Flathub

link:https://flathub.org/home[Flathub] is the home of hundreds of apps which can be easily installed on any Linux distribution.
Expand All @@ -786,3 +785,5 @@ nor a pull request for you. However, once your application has been accepted to
configuration to point to the appointed repository.

Please consult the link:https://github.com/flathub/flathub/wiki/App-Submission[App Submission] to know more.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/homebrew.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -782,3 +782,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/jbang.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -280,3 +280,5 @@ any of these expressions to skip a template named `README.md.tpl`:

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/jib.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1059,3 +1059,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/macports.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -364,3 +364,5 @@ You are responsible for submitting a ticket to MacPorts for updating an existing
JReleaser *does not* create a ticket nor a pull request for you.

Please consult the link:https://guide.macports.org/[MacPorts guide] to know more.

include::partial$packagers/repository.adoc[]
1 change: 1 addition & 0 deletions docs/modules/reference/pages/packagers/scoop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -297,3 +297,4 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.
If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/snap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -783,3 +783,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -307,3 +307,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/reference/pages/packagers/winget.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -896,3 +896,5 @@ to the target artifact to mark it as skipped for packaging with {tool_id}.

If there's a matching `LICENSE` file available at the root of the project it will be copied to the repository by default.
You may set an extra property named `skipLicenseFile` on {tool_id} to skip this behavior.

include::partial$packagers/repository.adoc[]
11 changes: 8 additions & 3 deletions docs/modules/reference/partials/packagers/gradle/tap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,13 @@ endif::docker[]
// icon:dot-circle[] icon:eye-slash[]
token = '__USE_ENVIRONMENT_VARIABLE__'

# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
# icon:dot-circle[] icon:file-alt[]
// Message when committing to the repository.
// If left unspecified, `{{distributionName}} {{tagName}}` will be used.
// icon:dot-circle[] icon:file-alt[]
commitMessage = '{{distributionName}} {{tagName}}'

// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
// icon:dot-circle[] icon:file-alt[]
extraProperties.put('foo', 'bar')
}
9 changes: 8 additions & 1 deletion docs/modules/reference/partials/packagers/json/tap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,12 @@ endif::docker[]
// Message when committing to the repository.
// If left unspecified, `{{distributionName}} {{tagName}}` will be used.
// icon:dot-circle[] icon:file-alt[]
"commitMessage": "{{distributionName}} {{tagName}}"
"commitMessage": "{{distributionName}} {{tagName}}",

// Additional properties used when evaluating templates.
// icon:dot-circle[] icon:file-alt[]
"extraProperties": {
// Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
"foo": "bar"
}
},
11 changes: 11 additions & 0 deletions docs/modules/reference/partials/packagers/maven/tap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,15 @@ endif::docker[]
icon:dot-circle[] icon:file-alt[]
-->
<commitMessage>{{distributionName}} {{tagName}}</commitMessage>

<!--
Additional properties used when evaluating templates.
icon:dot-circle[] icon:file-alt[]
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
-->
<foo>bar</foo>
</extraProperties>
</repository>
90 changes: 90 additions & 0 deletions docs/modules/reference/partials/packagers/repository.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
== Repository

The `repository` section allows setting extra properties that may be used to provide additional hints when interacting
with the git repository that holds packager files.

=== GitLab

Define a `projectIdentifier` property to directly locate the project associated with the repository, such as

[tabs]
====
YAML::
+
--
[source,yaml]
[subs="+macros,attributes"]
----
packagers:
{tool_id}:
repository:
extraProperties:
projectIdentifier: 12345678
----
--
TOML::
+
--
[source,toml]
[subs="+macros,attributes"]
----
[packagers.{tool_id}]
repository.extraProperties.projectIdentifier = "12345678"
----
--
JSON::
+
--
[source,json]
[subs="+macros,attributes"]
----
{
"packagers": {
"{tool_id}": {
"repository": {
"extraProperties": {
"projectIdentifier": "12345678"
}
}
}
}
}
----
--
Maven::
+
--
[source,xml]
[subs="+macros,attributes,verbatim"]
----
<jreleaser>
<packagers>
<{tool_id}>
<repository>
<extraProperties>
<projectIdentifier>12345678</projectIdentifier>
</extraProperties>
</repository>
</{tool_id}>
</packagers>
</jreleaser>
----
--
Gradle::
+
--
[source,groovy]
[subs="+macros,attributes"]
----
jreleaser {
packagers {
{tool_id} {
repository {
extraProperties.put("projectIdentifier", "12345678")
}
}
}
}
----
--
====
7 changes: 6 additions & 1 deletion docs/modules/reference/partials/packagers/toml/tap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,9 @@ endif::docker[]
# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
# icon:dot-circle[] icon:file-alt[]
repository.commitMessage = "{{distributionName}} {{tagName}}"
repository.commitMessage = "{{distributionName}} {{tagName}}"

# Additional properties used when evaluating templates.
# icon:dot-circle[] icon:file-alt[]
repository.extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
8 changes: 7 additions & 1 deletion docs/modules/reference/partials/packagers/yaml/tap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,10 @@ endif::docker[]
# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
# icon:dot-circle[] icon:file-alt[]
commitMessage: '{{distributionName}} {{tagName}}'
commitMessage: '{{distributionName}} {{tagName}}'

# Additional properties used when evaluating templates.
# icon:dot-circle[] icon:file-alt[]
extraProperties:
# Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
foo: bar

0 comments on commit 1d2a4fe

Please sign in to comment.