#528

Committed 05 Aug 2025 05:40PM UTC coverage: 49.2% (-0.006%) from 49.206%

Build # #528

Build Type

push

github

Committed by

aalmiray

Commit Message

feat(packagers): Allow packagers to skip publish step

Closes #1936

Coverage Stats

34 of 75 new or added lines in 40 files covered. (45.33%)

1 existing line in 1 file now uncovered.

26299 of 53453 relevant lines covered (49.2%)

0.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

41.94

/core/jreleaser-engine/src/main/java/org/jreleaser/packagers/ChocolateyPackagerProcessor.java

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2025 The JReleaser authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jreleaser.packagers;

import org.jreleaser.bundle.RB;
import org.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.distributions.Distribution;
import org.jreleaser.model.internal.packagers.ChocolateyPackager;
import org.jreleaser.model.internal.release.BaseReleaser;
import org.jreleaser.model.internal.release.GithubReleaser;
import org.jreleaser.model.internal.release.Releaser;
import org.jreleaser.model.spi.packagers.PackagerProcessingException;
import org.jreleaser.mustache.TemplateContext;
import org.jreleaser.sdk.command.Command;
import org.jreleaser.util.PlatformUtils;

import java.io.IOException;
import java.nio.file.Path;
import java.util.Optional;

import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_BUCKET_REPO_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_BUCKET_REPO_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_ICON_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_NAME;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_SOURCE_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_VERSION;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_REPOSITORY_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_REPOSITORY_URL;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_SOURCE;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_TITLE;
import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_USERNAME;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_PACKAGE_DIRECTORY;
import static org.jreleaser.model.Constants.KEY_PROJECT_LICENSE_URL;
import static org.jreleaser.mustache.Templates.resolveTemplate;
import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
import static org.jreleaser.util.FileUtils.listFilesAndProcess;
import static org.jreleaser.util.StringUtils.isBlank;

/**
 * @author Andres Almiray
 * @since 0.1.0
 */
public class ChocolateyPackagerProcessor extends AbstractRepositoryPackagerProcessor<ChocolateyPackager> {
    public ChocolateyPackagerProcessor(JReleaserContext context) {
        super(context);
    }

    @Override
    protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
        super.doPackageDistribution(distribution, props, packageDirectory);

        copyPreparedFiles(props);

        if (packager.isRemoteBuild()) {
            return;
        }

        if (!PlatformUtils.isWindows()) {
            context.getLogger().warn(RB.$("ERROR_packager_requires_platform", "Windows"));
            return;
        }

        createChocolateyPackage(distribution, props);
    }

    @Override
    protected void doPublishDistribution(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
        if (packager.isRemoteBuild()) {
            super.doPublishDistribution(distribution, props);
            return;
        }

        if (context.isDryrun()) {
            context.getLogger().error(RB.$("dryrun.set"));
            return;
        }

        if (!PlatformUtils.isWindows()) {
            context.getLogger().warn(RB.$("ERROR_packager_requires_platform", "Windows"));
            return;
        }

        if (packager.isSkipPublishing()) {
            context.getLogger().info(RB.$("packager.skip.publishing"));
            return;
        }
        publishChocolateyPackage(distribution, props);
    }

    @Override
    protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
        props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());
        props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());
        BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();

        if (!props.contains(KEY_PROJECT_LICENSE_URL) ||
            isBlank(props.get(KEY_PROJECT_LICENSE_URL))) {
            context.getLogger().warn(RB.$("ERROR_project_no_license_url"));
        }

        String releaseUrl = releaser.getResolvedRepoUrl(context.getModel());
        String repositoryUrl = releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName());

        props.set(KEY_CHOCOLATEY_BUCKET_REPO_URL, repositoryUrl);
        props.set(KEY_CHOCOLATEY_BUCKET_REPO_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_CHOCOLATEY_PACKAGE_SOURCE_URL, packager.isRemoteBuild() ? repositoryUrl : releaseUrl);
        props.set(KEY_CHOCOLATEY_REPOSITORY_URL, repositoryUrl);
        props.set(KEY_CHOCOLATEY_REPOSITORY_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));

        props.set(KEY_CHOCOLATEY_PACKAGE_NAME, packager.getPackageName());
        props.set(KEY_CHOCOLATEY_PACKAGE_VERSION, resolveTemplate(packager.getPackageVersion(), props));
        props.set(KEY_CHOCOLATEY_USERNAME, packager.getUsername());
        props.set(KEY_CHOCOLATEY_TITLE, packager.getTitle());
        props.set(KEY_CHOCOLATEY_ICON_URL, resolveTemplate(packager.getIconUrl(), props));
        props.set(KEY_CHOCOLATEY_SOURCE, packager.getSource());
    }

    @Override
    protected void writeFile(Distribution distribution,
                             String content,
                             TemplateContext props,
                             Path outputDirectory,
                             String fileName) throws PackagerProcessingException {
        Releaser<?> gitService = context.getModel().getRelease().getReleaser();
        if (fileName.contains(".github") && (!packager.isRemoteBuild() || !(gitService instanceof GithubReleaser))) {
            // skip
            return;
        }

        fileName = trimTplExtension(fileName);

        Path outputFile = "binary.nuspec".equals(fileName) ?
            outputDirectory.resolve(distribution.getName()).resolve(packager.getPackageName().concat(".nuspec")) :
            fileName.endsWith(".ps1") ? outputDirectory.resolve(distribution.getName()).resolve(fileName) :
                outputDirectory.resolve(fileName);

        writeFile(content, outputFile);
    }

    private void createChocolateyPackage(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
        Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);
        Path execDirectory = packageDirectory.resolve(distribution.getName());

        Command cmd = new Command("choco")
            .arg("pack")
            .arg(packager.getPackageName() + ".nuspec");

        context.getLogger().debug(String.join(" ", cmd.getArgs()));
        executeCommand(execDirectory, cmd);
    }

    private void publishChocolateyPackage(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
        Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);
        Path execDirectory = packageDirectory.resolve(distribution.getName());

        Command cmd = new Command("choco")
            .arg("apikey")
            .arg("-k")
            .arg(packager.getApiKey())
            .arg("-source")
            .arg(packager.getSource());
        executeCommand(execDirectory, cmd);

        try {
            Optional<String> nuget = listFilesAndProcess(execDirectory, files ->
                files.map(Path::getFileName)
                    .map(Path::toString)
                    .filter(s -> s.endsWith(".nupkg"))
                    .findFirst().orElse(null));

            if (nuget.isPresent()) {
                cmd = new Command("choco")
                    .arg("push")
                    .arg(nuget.get())
                    .arg("-s")
                    .arg(packager.getSource());

                context.getLogger().debug(String.join(" ", cmd.getArgs()));
                executeCommand(execDirectory, cmd);
            } else {
                throw new PackagerProcessingException(RB.$("ERROR_chocolatey_nuget_not_found",
                    context.relativizeToBasedir(execDirectory)));
            }
        } catch (IOException e) {
            throw new PackagerProcessingException(RB.$("ERROR_unexpected_error"), e);
        }
    }
}

1	/*
2	* SPDX-License-Identifier: Apache-2.0
3	*
4	* Copyright 2020-2025 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	package org.jreleaser.packagers;
19
20	import org.jreleaser.bundle.RB;
21	import org.jreleaser.model.internal.JReleaserContext;
22	import org.jreleaser.model.internal.distributions.Distribution;
23	import org.jreleaser.model.internal.packagers.ChocolateyPackager;
24	import org.jreleaser.model.internal.release.BaseReleaser;
25	import org.jreleaser.model.internal.release.GithubReleaser;
26	import org.jreleaser.model.internal.release.Releaser;
27	import org.jreleaser.model.spi.packagers.PackagerProcessingException;
28	import org.jreleaser.mustache.TemplateContext;
29	import org.jreleaser.sdk.command.Command;
30	import org.jreleaser.util.PlatformUtils;
31
32	import java.io.IOException;
33	import java.nio.file.Path;
34	import java.util.Optional;
35
36	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_BUCKET_REPO_CLONE_URL;
37	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_BUCKET_REPO_URL;
38	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_ICON_URL;
39	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_NAME;
40	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_SOURCE_URL;
41	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_PACKAGE_VERSION;
42	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_REPOSITORY_CLONE_URL;
43	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_REPOSITORY_URL;
44	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_SOURCE;
45	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_TITLE;
46	import static org.jreleaser.model.Constants.KEY_CHOCOLATEY_USERNAME;
47	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
48	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
49	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_PACKAGE_DIRECTORY;
50	import static org.jreleaser.model.Constants.KEY_PROJECT_LICENSE_URL;
51	import static org.jreleaser.mustache.Templates.resolveTemplate;
52	import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
53	import static org.jreleaser.util.FileUtils.listFilesAndProcess;
54	import static org.jreleaser.util.StringUtils.isBlank;
55
56	/**
57	* @author Andres Almiray
58	* @since 0.1.0
59	*/
60	public class ChocolateyPackagerProcessor extends AbstractRepositoryPackagerProcessor<ChocolateyPackager> {
61	public ChocolateyPackagerProcessor(JReleaserContext context) {
62	super(context);	1✔
63	}	1✔
64
65	@Override
66	protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
67	super.doPackageDistribution(distribution, props, packageDirectory);	1✔
68
69	copyPreparedFiles(props);	1✔
70
71	if (packager.isRemoteBuild()) {	1✔
72	return;	1✔
73	}
74
75	if (!PlatformUtils.isWindows()) {	×
76	context.getLogger().warn(RB.$("ERROR_packager_requires_platform", "Windows"));	×
77	return;	×
78	}
79
80	createChocolateyPackage(distribution, props);	×
81	}	×
82
83	@Override
84	protected void doPublishDistribution(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
85	if (packager.isRemoteBuild()) {	1✔
86	super.doPublishDistribution(distribution, props);	1✔
87	return;	1✔
88	}
89
90	if (context.isDryrun()) {	×
91	context.getLogger().error(RB.$("dryrun.set"));	×
92	return;	×
93	}
94
95	if (!PlatformUtils.isWindows()) {	×
96	context.getLogger().warn(RB.$("ERROR_packager_requires_platform", "Windows"));	×
97	return;	×
98	}
99
NEW 100	if (packager.isSkipPublishing()) {	×
NEW 101	context.getLogger().info(RB.$("packager.skip.publishing"));	×
NEW 102	return;	×
103	}
104	publishChocolateyPackage(distribution, props);	×
105	}	×
106
107	@Override
108	protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
109	props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());	1✔
110	props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());	1✔
111	BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();	1✔
112
113	if (!props.contains(KEY_PROJECT_LICENSE_URL) \|\|	1✔
114	isBlank(props.get(KEY_PROJECT_LICENSE_URL))) {	1✔
115	context.getLogger().warn(RB.$("ERROR_project_no_license_url"));	×
116	}
117
118	String releaseUrl = releaser.getResolvedRepoUrl(context.getModel());	1✔
119	String repositoryUrl = releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName());	1✔
120
121	props.set(KEY_CHOCOLATEY_BUCKET_REPO_URL, repositoryUrl);	1✔
122	props.set(KEY_CHOCOLATEY_BUCKET_REPO_CLONE_URL,	1✔
123	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
124	props.set(KEY_CHOCOLATEY_PACKAGE_SOURCE_URL, packager.isRemoteBuild() ? repositoryUrl : releaseUrl);	1✔
125	props.set(KEY_CHOCOLATEY_REPOSITORY_URL, repositoryUrl);	1✔
126	props.set(KEY_CHOCOLATEY_REPOSITORY_CLONE_URL,	1✔
127	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
128
129	props.set(KEY_CHOCOLATEY_PACKAGE_NAME, packager.getPackageName());	1✔
130	props.set(KEY_CHOCOLATEY_PACKAGE_VERSION, resolveTemplate(packager.getPackageVersion(), props));	1✔
131	props.set(KEY_CHOCOLATEY_USERNAME, packager.getUsername());	1✔
132	props.set(KEY_CHOCOLATEY_TITLE, packager.getTitle());	1✔
133	props.set(KEY_CHOCOLATEY_ICON_URL, resolveTemplate(packager.getIconUrl(), props));	1✔
134	props.set(KEY_CHOCOLATEY_SOURCE, packager.getSource());	1✔
135	}	1✔
136
137	@Override
138	protected void writeFile(Distribution distribution,
139	String content,
140	TemplateContext props,
141	Path outputDirectory,
142	String fileName) throws PackagerProcessingException {
143	Releaser<?> gitService = context.getModel().getRelease().getReleaser();	1✔
144	if (fileName.contains(".github") && (!packager.isRemoteBuild() \|\| !(gitService instanceof GithubReleaser))) {	1✔
145	// skip
146	return;	×
147	}
148
149	fileName = trimTplExtension(fileName);	1✔
150
151	Path outputFile = "binary.nuspec".equals(fileName) ?	1✔
152	outputDirectory.resolve(distribution.getName()).resolve(packager.getPackageName().concat(".nuspec")) :	1✔
153	fileName.endsWith(".ps1") ? outputDirectory.resolve(distribution.getName()).resolve(fileName) :	1✔
154	outputDirectory.resolve(fileName);	1✔
155
156	writeFile(content, outputFile);	1✔
157	}	1✔
158
159	private void createChocolateyPackage(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
160	Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);	×
161	Path execDirectory = packageDirectory.resolve(distribution.getName());	×
162
163	Command cmd = new Command("choco")	×
164	.arg("pack")	×
165	.arg(packager.getPackageName() + ".nuspec");	×
166
167	context.getLogger().debug(String.join(" ", cmd.getArgs()));	×
168	executeCommand(execDirectory, cmd);	×
169	}	×
170
171	private void publishChocolateyPackage(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
172	Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);	×
173	Path execDirectory = packageDirectory.resolve(distribution.getName());	×
174
175	Command cmd = new Command("choco")	×
176	.arg("apikey")	×
177	.arg("-k")	×
178	.arg(packager.getApiKey())	×
179	.arg("-source")	×
180	.arg(packager.getSource());	×
181	executeCommand(execDirectory, cmd);	×
182
183	try {
184	Optional<String> nuget = listFilesAndProcess(execDirectory, files ->	×
185	files.map(Path::getFileName)	×
186	.map(Path::toString)	×
187	.filter(s -> s.endsWith(".nupkg"))	×
188	.findFirst().orElse(null));	×
189
190	if (nuget.isPresent()) {	×
191	cmd = new Command("choco")	×
192	.arg("push")	×
193	.arg(nuget.get())	×
194	.arg("-s")	×
195	.arg(packager.getSource());	×
196
197	context.getLogger().debug(String.join(" ", cmd.getArgs()));	×
198	executeCommand(execDirectory, cmd);	×
199	} else {
200	throw new PackagerProcessingException(RB.$("ERROR_chocolatey_nuget_not_found",	×
201	context.relativizeToBasedir(execDirectory)));	×
202	}
203	} catch (IOException e) {	×
204	throw new PackagerProcessingException(RB.$("ERROR_unexpected_error"), e);	×
205	}	×
206	}	×
207	}

jreleaser / jreleaser / #528

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous