Skip to content

Commit 6642e8f

Browse files
committed
Update config instructions for all helloworld examples
1 parent 88226a2 commit 6642e8f

File tree

15 files changed

+45
-0
lines changed

15 files changed

+45
-0
lines changed

docs/modules/examples/pages/java/binary.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ The https://github.com/jreleaser/helloworld-java-graalvm[] repository shows how
1010
* assemble distributions with JReleaser
1111
* create rolling early-access releases with JReleaser on every push to `main` branch
1212

13+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
14+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].
15+
1316
There are two modes for packaging this application: classpath & modulepath.
1417

1518
*classpath*

docs/modules/examples/pages/java/java-binary.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ The https://github.com/jreleaser/helloworld-java-bin[] repository shows how to c
66
* assemble a zip distributions with JReleaser
77
* create rolling early-access releases with JReleaser on every push to `main` branch
88

9+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
10+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].
11+
912
There are two modes for packaging this application: classpath & modulepath.
1013

1114
*classpath*

docs/modules/examples/pages/java/jlink.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The https://github.com/jreleaser/helloworld-java-jlink[] repository shows how to
1313
* assemble zip distributions with JReleaser
1414
* create rolling early-access releases with JReleaser on every push to `main` branch
1515

16+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
17+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].
18+
1619
There are two modes for packaging this application: classpath & modulepath.
1720

1821
*classpath*

docs/modules/examples/pages/java/jpackage.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ The https://github.com/jreleaser/helloworld-java-jpackage[] repository shows how
1010
* assemble distributions with JReleaser
1111
* create rolling early-access releases with JReleaser on every push to `main` branch
1212

13+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
14+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].
15+
1316
There are two modes for packaging this application: classpath & modulepath.
1417

1518
*classpath*

docs/modules/examples/pages/java/single-jar.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ The https://github.com/jreleaser/helloworld-java-jar[] repository shows how to c
55
* compile a helloworld app
66
* create rolling early-access releases with JReleaser on every push to `main` branch
77

8+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
9+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].
10+
811
There are two modes for running this application: classpath & modulepath.
912

1013
*classpath*

docs/modules/examples/pages/miscellaneous/ballerina.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@ The https://github.com/jreleaser/helloworld-ballerina[] repository shows how to
44

55
* compile a helloworld app
66
* create rolling early-access releases with JReleaser on every push to `main` branch
7+
8+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
9+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].

docs/modules/examples/pages/miscellaneous/cpp.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ The link:https://github.com/jreleaser/helloworld-cpp[] repository shows the conf
88
** `windows-x86_64`
99
- Assemble zip distributions with JReleaser
1010
- Create rolling early-access releases with JReleaser on every push to `main` branch
11+
12+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
13+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].

docs/modules/examples/pages/miscellaneous/crystal.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ The link:https://github.com/jreleaser/helloworld-crystal[] repository shows the
88
** `windows-x86_64`
99
- Assemble zip distributions with JReleaser
1010
- Create rolling early-access releases with JReleaser on every push to `main` branch
11+
12+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
13+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].

docs/modules/examples/pages/miscellaneous/csharp-cross-platform.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ The link:https://github.com/jreleaser/helloworld-csharp[] repository shows the c
1212
** `osx-arm64`
1313
- Assemble zip distributions with JReleaser
1414
- Create rolling early-access releases with JReleaser on every push to `main` branch
15+
16+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
17+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].

docs/modules/examples/pages/miscellaneous/elixir.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ The link:https://github.com/jreleaser/helloworld-elixir[] repository shows the c
88
** `x86_64-unknown-linux-gnu`
99
- Assemble zip distributions with JReleaser
1010
- Create rolling early-access releases with JReleaser on every push to `main` branch
11+
12+
IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
13+
More information about environment variable configuration may be found xref:reference:environment.adoc[here].

0 commit comments

Comments
 (0)