├── .github ├── FUNDING.yml └── workflows │ └── test.yml ├── .gitignore ├── LICENSE ├── README.adoc ├── action.yml └── get_jreleaser.java /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | patreon: aalmiray 2 | github: aalmiray 3 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: 4 | push: 5 | workflow_dispatch: 6 | 7 | jobs: 8 | test: 9 | name: 'Java ${{ matrix.java }} on ${{ matrix.os }}' 10 | strategy: 11 | fail-fast: false 12 | matrix: 13 | os: [ ubuntu-latest, macos-latest, macos-14, windows-latest ] 14 | java: [ 11, 17, 21 ] 15 | runs-on: ${{ matrix.os }} 16 | steps: 17 | - uses: actions/checkout@v4 18 | 19 | - uses: actions/setup-java@v4 20 | with: 21 | java-version: ${{ matrix.java }} 22 | distribution: zulu 23 | 24 | - uses: ./ 25 | with: 26 | arguments: --version 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | *.iml 3 | .DS_Store 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = JReleaser 2 | :linkattrs: 3 | :project-owner: jreleaser 4 | :project-name: release-action 5 | 6 | image:https://github.com/{project-owner}/{project-name}/workflows/Test/badge.svg["Build Status", link="https://github.com/{project-owner}/{project-name}/actions"] 7 | image:https://img.shields.io/github/v/release/{project-owner}/{project-name}["GitHub release", link="https://github.com/jreleaser/release-action/releases"] 8 | image:https://img.shields.io/twitter/follow/{project-owner}?style=social["Twitter Follow", link="https://twitter.com/jreleaser"] 9 | 10 | This action executes a link:https://jreleaser.org[JReleaser] workflow. 11 | 12 | == Usage 13 | 14 | === Workflow 15 | 16 | [source,yaml] 17 | ---- 18 | name: release 19 | 20 | on: 21 | workflow_dispatch: 22 | 23 | jobs: 24 | release: 25 | name: Release 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout 30 | uses: actions/checkout@v4 31 | with: 32 | fetch-depth: 0 33 | 34 | # Configure build steps as you'd normally do 35 | 36 | - name: Setup Java 37 | uses: actions/setup-java@v4 38 | with: 39 | java-version: 21 40 | distribution: 'zulu' 41 | server-id: central 42 | server-username: MAVEN_USERNAME 43 | server-password: MAVEN_CENTRAL_TOKEN 44 | gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} 45 | gpg-passphrase: MAVEN_GPG_PASSPHRASE 46 | cache: maven 47 | 48 | # Post JARs to Maven Central 49 | 50 | - name: Release to Maven Central 51 | env: 52 | MAVEN_USERNAME: ${{ secrets.SONATYPE_USERNAME }} 53 | MAVEN_CENTRAL_TOKEN: ${{ secrets.SONATYPE_PASSWORD }} 54 | MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} 55 | run: | 56 | export GPG_TTY=$(tty) 57 | git config user.name "${{ github.event.head_commit.committer.name }}" 58 | git config user.email "${{ github.event.head_commit.committer.email }}" 59 | mvn -B --file pom.xml release:prepare release:perform 60 | 61 | # Create a release 62 | 63 | - name: Run JReleaser 64 | uses: jreleaser/release-action@v2 65 | env: 66 | JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 67 | 68 | # Persist logs 69 | 70 | - name: JReleaser release output 71 | if: always() 72 | uses: actions/upload-artifact@v4 73 | with: 74 | name: jreleaser-release 75 | path: | 76 | out/jreleaser/trace.log 77 | out/jreleaser/output.properties 78 | ---- 79 | 80 | WARNING: Note the `fetch-depth: 0` option on the `Checkout` workflow step. It is required for JReleaser to work properly. 81 | Without that, JReleaser might fail or behave incorrectly. 82 | 83 | The last step executes a `full-release` with the default `jreleaser.yml` configuration that's expected to be located at 84 | the root of the repository. 85 | 86 | IMPORTANT: This action requires Java 11+ to download and execute JReleaser. The action will setup a suitable Java runtime 87 | automatically. If you would like to use a different Java version/distribution then set the value of `setup-java` to `false` 88 | and make sure you have a previous step with `actions/setup-java` setup as needed. 89 | 90 | == Customizing 91 | 92 | == Inputs 93 | 94 | Following inputs can be used as `step.with` keys 95 | 96 | [%header,cols="<2,<,<2,<3",width="100%"] 97 | |=== 98 | | Name | Type | Default | Description 99 | | version | String | latest | The JReleaser version to use. + 100 | Should match any of the link:https://github.com/jreleaser/jreleaser/releases[published releases]. + 101 | You may use `latest` to pull the latest stable release or + 102 | `early-access` to pull the latest snapshot. 103 | | arguments | String | full-release | The JReleaser command to run. 104 | | working-directory | String | ${{ github.workspace }} | The directory to change into. + 105 | Defaults to the directory the calling workflow runs in. 106 | | setup-java | boolean | true | Automatically setup a Java runtime. + 107 | Java runtime defaults to Zulu 17. 108 | | java-opts | boolean | | Additional JVM parameters for running JReleaser 109 | |=== 110 | 111 | == Environment Variables 112 | 113 | Following environment variables can be used as `step.env` keys 114 | 115 | [%header,width="100%"] 116 | |=== 117 | | Name | Description 118 | | JRELEASER_GITHUB_TOKEN | link:https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token[GITHUB_TOKEN] 119 | as provided by `secrets` 120 | |=== 121 | 122 | == Caution 123 | 124 | The default `GITHUB_TOKEN` from `secrets` is link:https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#about-the-github_token-secret[limited] 125 | to the repository that contains your workflow. 126 | 127 | Pushing to other repositories such as Homebrew tap requires additional permissions, you must create a custom 128 | link:https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/[Personal Access Token] with 129 | `repo` permissions and link:https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets[add it as a secret in the repository]. 130 | If you create a secret named `GH_PAT`, the step will look like this 131 | 132 | [source,yaml] 133 | ---- 134 | - name: Run JReleaser 135 | uses: jreleaser/release-action@v2 136 | env: 137 | JRELEASER_GITHUB_TOKEN: ${{ secrets.GH_PAT }} 138 | ---- 139 | 140 | If you'd rather have separate tokens for each additional repository and keep the original `GITHUB_TOKEN` intact then 141 | you may apply the `GH_PAT` token as follows 142 | 143 | [source,yaml] 144 | ---- 145 | - name: Run JReleaser 146 | uses: jreleaser/release-action@v2 147 | env: 148 | JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 149 | JRELEASER_HOMEBREW_GITHUB_TOKEN: ${{ secrets.GH_PAT }} 150 | ---- 151 | 152 | Additional environment variables may be needed depending on your specific setup, such as those needed for signing files 153 | with GPG or announcing a release via Twitter. Review the docs at link:https://jreleaser.org[] to find more about these 154 | variables and how to set them up. 155 | 156 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | # 2 | # SPDX-License-Identifier: Apache-2.0 3 | # 4 | # Copyright 2020-2023 The JReleaser authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | name: JReleaser 20 | 21 | description: 'Release Java projects quickly and easily with JReleaser' 22 | 23 | branding: 24 | icon: 'archive' 25 | color: 'gray-dark' 26 | 27 | inputs: 28 | version: 29 | description: 'The version of JReleaser to download and execute.' 30 | default: 'latest' 31 | required: true 32 | 33 | arguments: 34 | description: 'The command-line arguments to be passed to JReleaser.' 35 | default: 'full-release' 36 | required: true 37 | 38 | working-directory: 39 | required: true 40 | default: ${{ github.workspace }} 41 | description: 'The directory to change into.' 42 | 43 | setup-java: 44 | default: 'true' 45 | description: 'Setup internal Java runtime.' 46 | required: false 47 | 48 | java-opts: 49 | default: '' 50 | description: 'Additional JVM parameters' 51 | required: false 52 | 53 | runs: 54 | using: 'composite' 55 | steps: 56 | - name: 'Setup Java' 57 | uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 # v 4.0.0 58 | if: ${{ inputs.setup-java == 'true' }} 59 | with: 60 | java-version: 17 61 | distribution: 'zulu' 62 | 63 | - name: 'Download JReleaser' 64 | shell: bash 65 | working-directory: ${{ inputs.working-directory }} 66 | run: | 67 | echo "::group::📦 Download JReleaser" 68 | java "${{ github.action_path }}/get_jreleaser.java" ${{ inputs.version }} 69 | java -jar jreleaser-cli.jar --version 70 | echo "::endgroup::" 71 | 72 | - name: 'Execute JReleaser' 73 | shell: bash 74 | working-directory: ${{ inputs.working-directory }} 75 | run: | 76 | echo "☕ java -jar jreleaser-cli.jar ${{ inputs.arguments }}" 77 | java ${{ inputs.java-opts }} -jar jreleaser-cli.jar ${{ inputs.arguments }} 78 | -------------------------------------------------------------------------------- /get_jreleaser.java: -------------------------------------------------------------------------------- 1 | //JAVA 11+ 2 | 3 | import java.io.FileNotFoundException; 4 | import java.io.IOException; 5 | import java.net.URL; 6 | import java.nio.file.Files; 7 | import java.nio.file.Path; 8 | 9 | import static java.nio.file.StandardCopyOption.REPLACE_EXISTING; 10 | import static java.nio.file.StandardOpenOption.CREATE; 11 | import static java.nio.file.StandardOpenOption.TRUNCATE_EXISTING; 12 | import static java.nio.file.StandardOpenOption.WRITE; 13 | 14 | class get_jreleaser { 15 | public static void main(String... args) throws Exception { 16 | // default version 17 | var version = "latest"; 18 | 19 | if (args.length > 1) { 20 | System.err.println("Usage: java get_jreleaser.java [VERSION]"); 21 | System.exit(1); 22 | } 23 | 24 | // grab the version if specified 25 | if (args.length == 1) { 26 | version = args[0]; 27 | } 28 | 29 | // check 30 | if (null == version || version.isEmpty()) { 31 | System.out.printf("❌ Version '%s' is invalid%n", version); 32 | System.exit(1); 33 | } 34 | 35 | var versionFile = Path.of("JRELEASER_VERSION"); 36 | 37 | var cachedVersion = ""; 38 | if (Files.exists(versionFile)) { 39 | try { 40 | cachedVersion = Files.readString(versionFile).trim(); 41 | } catch (IOException e) { 42 | System.out.printf("☠️ JReleaser %s could not be resolved%n", version); 43 | e.printStackTrace(); 44 | System.exit(1); 45 | } 46 | } 47 | 48 | // resolve latest to a tagged release 49 | if ("latest".equalsIgnoreCase(version)) { 50 | var url = "https://jreleaser.org/releases/latest/download/VERSION"; 51 | 52 | try (var stream = new URL(url).openStream()) { 53 | System.out.printf("✅ Located version marker%n"); 54 | Files.copy(stream, versionFile, REPLACE_EXISTING); 55 | version = new String(Files.readAllBytes(versionFile)).trim(); 56 | System.out.printf("✅ JReleaser latest resolves to %s%n", version); 57 | } catch (FileNotFoundException e) { 58 | System.out.printf("❌ JReleaser %s not found%n", version); 59 | e.printStackTrace(); 60 | System.exit(1); 61 | } catch (IOException e) { 62 | System.out.printf("☠️ JReleaser %s could not be downloaded/copied%n", version); 63 | e.printStackTrace(); 64 | System.exit(1); 65 | } 66 | } else { 67 | try { 68 | Files.writeString(versionFile, version, CREATE, TRUNCATE_EXISTING, WRITE); 69 | } catch (IOException e) { 70 | System.out.printf("☠️ JReleaser %s could not be resolved%n", version); 71 | e.printStackTrace(); 72 | System.exit(1); 73 | } 74 | } 75 | 76 | var jreleaserJar = Path.of("jreleaser-cli.jar"); 77 | if (version.equals(cachedVersion) && Files.exists(jreleaserJar)) { 78 | // assume jreleaserJar has the expected version for now 79 | System.out.printf("✅ JReleaser %s already downloaded%n", version); 80 | System.exit(0); 81 | } 82 | 83 | // setup the actual download 84 | var tag = !"early-access".equals(version) ? "v" + version : version; 85 | var url = "https://github.com/jreleaser/jreleaser/releases/download/" + tag + "/jreleaser-tool-provider-" + version + ".jar"; 86 | 87 | try (var stream = new URL(url).openStream()) { 88 | System.out.printf("✅ Located JReleaser %s%n", version); 89 | System.out.printf("⬇️ Downloading %s%n", url); 90 | var size = Files.copy(stream, jreleaserJar, REPLACE_EXISTING); 91 | System.out.printf("%s << copied %d bytes%n", jreleaserJar, size); 92 | System.out.printf("✅ JReleaser installed successfully%n"); 93 | } catch (FileNotFoundException e) { 94 | System.out.printf("❌ JReleaser %s not found%n", version); 95 | System.exit(1); 96 | } catch (IOException e) { 97 | System.out.printf("☠️ JReleaser %s could not be downloaded/copied%n", version); 98 | e.printStackTrace(); 99 | System.exit(1); 100 | } 101 | } 102 | } 103 | --------------------------------------------------------------------------------