#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

52.94

/core/jreleaser-engine/src/main/java/org/jreleaser/packagers/SnapPackagerProcessor.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.SnapPackager;
import org.jreleaser.model.internal.release.BaseReleaser;
import org.jreleaser.model.spi.packagers.PackagerProcessingException;
import org.jreleaser.mustache.MustacheUtils;
import org.jreleaser.mustache.TemplateContext;
import org.jreleaser.sdk.command.Command;
import org.jreleaser.util.PlatformUtils;

import java.nio.file.Path;
import java.util.Arrays;
import java.util.stream.Collectors;

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_EFFECTIVE_VERSION;
import static org.jreleaser.model.Constants.KEY_PROJECT_LONG_DESCRIPTION;
import static org.jreleaser.model.Constants.KEY_SNAP_ARCHITECTURES;
import static org.jreleaser.model.Constants.KEY_SNAP_BASE;
import static org.jreleaser.model.Constants.KEY_SNAP_CONFINEMENT;
import static org.jreleaser.model.Constants.KEY_SNAP_GRADE;
import static org.jreleaser.model.Constants.KEY_SNAP_HAS_ARCHITECTURES;
import static org.jreleaser.model.Constants.KEY_SNAP_HAS_LOCAL_PLUGS;
import static org.jreleaser.model.Constants.KEY_SNAP_HAS_LOCAL_SLOTS;
import static org.jreleaser.model.Constants.KEY_SNAP_HAS_PLUGS;
import static org.jreleaser.model.Constants.KEY_SNAP_HAS_SLOTS;
import static org.jreleaser.model.Constants.KEY_SNAP_LOCAL_PLUGS;
import static org.jreleaser.model.Constants.KEY_SNAP_LOCAL_SLOTS;
import static org.jreleaser.model.Constants.KEY_SNAP_PACKAGE_NAME;
import static org.jreleaser.model.Constants.KEY_SNAP_PLUGS;
import static org.jreleaser.model.Constants.KEY_SNAP_REPOSITORY_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_SNAP_REPOSITORY_URL;
import static org.jreleaser.model.Constants.KEY_SNAP_REPO_CLONE_URL;
import static org.jreleaser.model.Constants.KEY_SNAP_REPO_URL;
import static org.jreleaser.model.Constants.KEY_SNAP_SLOTS;
import static org.jreleaser.templates.TemplateUtils.trimTplExtension;

/**
 * @author Andres Almiray
 * @since 0.1.0
 */
public class SnapPackagerProcessor extends AbstractRepositoryPackagerProcessor<SnapPackager> {
    public SnapPackagerProcessor(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_excludes_platform", "Windows"));
            return;
        }

        createSnap(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_excludes_platform", "Windows"));
            return;
        }

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

        login(distribution);
        push(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();

        String desc = context.getModel().getProject().getLongDescription();
        desc = Arrays.stream(desc.split(System.lineSeparator()))
            .map(line -> "  " + line)
            .collect(Collectors.joining(System.lineSeparator()));
        props.set(KEY_PROJECT_LONG_DESCRIPTION,
            MustacheUtils.passThrough("|" + System.lineSeparator() + desc));

        props.set(KEY_SNAP_REPO_URL,
            releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_SNAP_REPO_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));

        props.set(KEY_SNAP_REPOSITORY_URL,
            releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));
        props.set(KEY_SNAP_REPOSITORY_CLONE_URL,
            releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));

        props.set(KEY_SNAP_PACKAGE_NAME, packager.getPackageName());
        props.set(KEY_SNAP_BASE, packager.getBase());
        props.set(KEY_SNAP_GRADE, packager.getGrade());
        props.set(KEY_SNAP_CONFINEMENT, packager.getConfinement());
        props.set(KEY_SNAP_HAS_PLUGS, !packager.getPlugs().isEmpty());
        props.set(KEY_SNAP_PLUGS, packager.getPlugs());
        props.set(KEY_SNAP_HAS_SLOTS, !packager.getSlots().isEmpty());
        props.set(KEY_SNAP_SLOTS, packager.getSlots());
        props.set(KEY_SNAP_HAS_LOCAL_PLUGS, !packager.getLocalPlugs().isEmpty());
        props.set(KEY_SNAP_LOCAL_PLUGS, packager.getLocalPlugs());
        props.set(KEY_SNAP_HAS_LOCAL_SLOTS, !packager.getLocalSlots().isEmpty());
        props.set(KEY_SNAP_LOCAL_SLOTS, packager.getLocalSlots());
        props.set(KEY_SNAP_HAS_ARCHITECTURES, !packager.getArchitectures().isEmpty());
        props.set(KEY_SNAP_ARCHITECTURES, packager.getArchitectures());
    }

    @Override
    protected void writeFile(Distribution distribution,
                             String content,
                             TemplateContext props,
                             Path outputDirectory,
                             String fileName) throws PackagerProcessingException {
        fileName = trimTplExtension(fileName);

        Path outputFile = outputDirectory.resolve(fileName);

        writeFile(content, outputFile);
    }

    private void login(Distribution distribution) throws PackagerProcessingException {
        Command cmd = new Command("snapcraft")
            .arg("login")
            .arg("--with")
            .arg(context.getBasedir().resolve(distribution.getSnap().getExportedLogin()).toAbsolutePath().toString());
        executeCommand(cmd);
    }

    private void push(TemplateContext props) throws PackagerProcessingException {
        Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);
        String version = props.get(KEY_PROJECT_EFFECTIVE_VERSION);
        String snapName = packager.getPackageName() + "-" + version + ".snap";

        Command cmd = new Command("snapcraft")
            .arg("push")
            .arg(snapName);
        executeCommand(packageDirectory, cmd);
    }

    private void createSnap(TemplateContext props) throws PackagerProcessingException {
        Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);
        String version = props.get(KEY_PROJECT_EFFECTIVE_VERSION);
        String snapName = packager.getPackageName() + "-" + version + ".snap";

        Command cmd = new Command("snapcraft")
            .arg("snap")
            .arg("--output")
            .arg(snapName);
        executeCommand(packageDirectory, cmd);
    }
}

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.SnapPackager;
24	import org.jreleaser.model.internal.release.BaseReleaser;
25	import org.jreleaser.model.spi.packagers.PackagerProcessingException;
26	import org.jreleaser.mustache.MustacheUtils;
27	import org.jreleaser.mustache.TemplateContext;
28	import org.jreleaser.sdk.command.Command;
29	import org.jreleaser.util.PlatformUtils;
30
31	import java.nio.file.Path;
32	import java.util.Arrays;
33	import java.util.stream.Collectors;
34
35	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_CLASS;
36	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_JAVA_MAIN_MODULE;
37	import static org.jreleaser.model.Constants.KEY_DISTRIBUTION_PACKAGE_DIRECTORY;
38	import static org.jreleaser.model.Constants.KEY_PROJECT_EFFECTIVE_VERSION;
39	import static org.jreleaser.model.Constants.KEY_PROJECT_LONG_DESCRIPTION;
40	import static org.jreleaser.model.Constants.KEY_SNAP_ARCHITECTURES;
41	import static org.jreleaser.model.Constants.KEY_SNAP_BASE;
42	import static org.jreleaser.model.Constants.KEY_SNAP_CONFINEMENT;
43	import static org.jreleaser.model.Constants.KEY_SNAP_GRADE;
44	import static org.jreleaser.model.Constants.KEY_SNAP_HAS_ARCHITECTURES;
45	import static org.jreleaser.model.Constants.KEY_SNAP_HAS_LOCAL_PLUGS;
46	import static org.jreleaser.model.Constants.KEY_SNAP_HAS_LOCAL_SLOTS;
47	import static org.jreleaser.model.Constants.KEY_SNAP_HAS_PLUGS;
48	import static org.jreleaser.model.Constants.KEY_SNAP_HAS_SLOTS;
49	import static org.jreleaser.model.Constants.KEY_SNAP_LOCAL_PLUGS;
50	import static org.jreleaser.model.Constants.KEY_SNAP_LOCAL_SLOTS;
51	import static org.jreleaser.model.Constants.KEY_SNAP_PACKAGE_NAME;
52	import static org.jreleaser.model.Constants.KEY_SNAP_PLUGS;
53	import static org.jreleaser.model.Constants.KEY_SNAP_REPOSITORY_CLONE_URL;
54	import static org.jreleaser.model.Constants.KEY_SNAP_REPOSITORY_URL;
55	import static org.jreleaser.model.Constants.KEY_SNAP_REPO_CLONE_URL;
56	import static org.jreleaser.model.Constants.KEY_SNAP_REPO_URL;
57	import static org.jreleaser.model.Constants.KEY_SNAP_SLOTS;
58	import static org.jreleaser.templates.TemplateUtils.trimTplExtension;
59
60	/**
61	* @author Andres Almiray
62	* @since 0.1.0
63	*/
64	public class SnapPackagerProcessor extends AbstractRepositoryPackagerProcessor<SnapPackager> {
65	public SnapPackagerProcessor(JReleaserContext context) {
66	super(context);	1✔
67	}	1✔
68
69	@Override
70	protected void doPackageDistribution(Distribution distribution, TemplateContext props, Path packageDirectory) throws PackagerProcessingException {
71	super.doPackageDistribution(distribution, props, packageDirectory);	1✔
72	copyPreparedFiles(props);	1✔
73
74	if (packager.isRemoteBuild()) {	1✔
75	return;	1✔
76	}
77
78	if (PlatformUtils.isWindows()) {	×
79	context.getLogger().warn(RB.$("ERROR_packager_excludes_platform", "Windows"));	×
80	return;	×
81	}
82
83	createSnap(props);	×
84	}	×
85
86	@Override
87	protected void doPublishDistribution(Distribution distribution, TemplateContext props) throws PackagerProcessingException {
88	if (packager.isRemoteBuild()) {	1✔
89	super.doPublishDistribution(distribution, props);	1✔
90	return;	1✔
91	}
92
93	if (context.isDryrun()) {	×
94	context.getLogger().error(RB.$("dryrun.set"));	×
95	return;	×
96	}
97
98	if (PlatformUtils.isWindows()) {	×
99	context.getLogger().warn(RB.$("ERROR_packager_excludes_platform", "Windows"));	×
100	return;	×
101	}
102
NEW 103	if (packager.isSkipPublishing()) {	×
NEW 104	context.getLogger().info(RB.$("packager.skip.publishing"));	×
NEW 105	return;	×
106	}
107
108	login(distribution);	×
109	push(props);	×
110	}	×
111
112	@Override
113	protected void fillPackagerProperties(TemplateContext props, Distribution distribution) {
114	props.set(KEY_DISTRIBUTION_JAVA_MAIN_CLASS, distribution.getJava().getMainClass());	1✔
115	props.set(KEY_DISTRIBUTION_JAVA_MAIN_MODULE, distribution.getJava().getMainModule());	1✔
116	BaseReleaser<?, ?> releaser = context.getModel().getRelease().getReleaser();	1✔
117
118	String desc = context.getModel().getProject().getLongDescription();	1✔
119	desc = Arrays.stream(desc.split(System.lineSeparator()))	1✔
120	.map(line -> " " + line)	1✔
121	.collect(Collectors.joining(System.lineSeparator()));	1✔
122	props.set(KEY_PROJECT_LONG_DESCRIPTION,	1✔
123	MustacheUtils.passThrough("\|" + System.lineSeparator() + desc));	1✔
124
125	props.set(KEY_SNAP_REPO_URL,	1✔
126	releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
127	props.set(KEY_SNAP_REPO_CLONE_URL,	1✔
128	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
129
130	props.set(KEY_SNAP_REPOSITORY_URL,	1✔
131	releaser.getResolvedRepoUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
132	props.set(KEY_SNAP_REPOSITORY_CLONE_URL,	1✔
133	releaser.getResolvedRepoCloneUrl(context.getModel(), packager.getRepository().getOwner(), packager.getRepository().getResolvedName()));	1✔
134
135	props.set(KEY_SNAP_PACKAGE_NAME, packager.getPackageName());	1✔
136	props.set(KEY_SNAP_BASE, packager.getBase());	1✔
137	props.set(KEY_SNAP_GRADE, packager.getGrade());	1✔
138	props.set(KEY_SNAP_CONFINEMENT, packager.getConfinement());	1✔
139	props.set(KEY_SNAP_HAS_PLUGS, !packager.getPlugs().isEmpty());	1✔
140	props.set(KEY_SNAP_PLUGS, packager.getPlugs());	1✔
141	props.set(KEY_SNAP_HAS_SLOTS, !packager.getSlots().isEmpty());	1✔
142	props.set(KEY_SNAP_SLOTS, packager.getSlots());	1✔
143	props.set(KEY_SNAP_HAS_LOCAL_PLUGS, !packager.getLocalPlugs().isEmpty());	1✔
144	props.set(KEY_SNAP_LOCAL_PLUGS, packager.getLocalPlugs());	1✔
145	props.set(KEY_SNAP_HAS_LOCAL_SLOTS, !packager.getLocalSlots().isEmpty());	1✔
146	props.set(KEY_SNAP_LOCAL_SLOTS, packager.getLocalSlots());	1✔
147	props.set(KEY_SNAP_HAS_ARCHITECTURES, !packager.getArchitectures().isEmpty());	1✔
148	props.set(KEY_SNAP_ARCHITECTURES, packager.getArchitectures());	1✔
149	}	1✔
150
151	@Override
152	protected void writeFile(Distribution distribution,
153	String content,
154	TemplateContext props,
155	Path outputDirectory,
156	String fileName) throws PackagerProcessingException {
157	fileName = trimTplExtension(fileName);	1✔
158
159	Path outputFile = outputDirectory.resolve(fileName);	1✔
160
161	writeFile(content, outputFile);	1✔
162	}	1✔
163
164	private void login(Distribution distribution) throws PackagerProcessingException {
165	Command cmd = new Command("snapcraft")	×
166	.arg("login")	×
167	.arg("--with")	×
168	.arg(context.getBasedir().resolve(distribution.getSnap().getExportedLogin()).toAbsolutePath().toString());	×
169	executeCommand(cmd);	×
170	}	×
171
172	private void push(TemplateContext props) throws PackagerProcessingException {
173	Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);	×
174	String version = props.get(KEY_PROJECT_EFFECTIVE_VERSION);	×
175	String snapName = packager.getPackageName() + "-" + version + ".snap";	×
176
177	Command cmd = new Command("snapcraft")	×
178	.arg("push")	×
179	.arg(snapName);	×
180	executeCommand(packageDirectory, cmd);	×
181	}	×
182
183	private void createSnap(TemplateContext props) throws PackagerProcessingException {
184	Path packageDirectory = props.get(KEY_DISTRIBUTION_PACKAGE_DIRECTORY);	×
185	String version = props.get(KEY_PROJECT_EFFECTIVE_VERSION);	×
186	String snapName = packager.getPackageName() + "-" + version + ".snap";	×
187
188	Command cmd = new Command("snapcraft")	×
189	.arg("snap")	×
190	.arg("--output")	×
191	.arg(snapName);	×
192	executeCommand(packageDirectory, cmd);	×
193	}	×
194	}

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