#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

72.15

/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/packagers/SpecPackager.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.model.internal.packagers;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.jreleaser.model.Active;
import org.jreleaser.model.Distribution;
import org.jreleaser.model.Stereotype;
import org.jreleaser.model.internal.common.Artifact;
import org.jreleaser.util.PlatformUtils;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static java.util.Collections.emptySet;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;
import static java.util.Collections.unmodifiableSet;
import static org.jreleaser.model.Distribution.DistributionType.BINARY;
import static org.jreleaser.model.Distribution.DistributionType.FLAT_BINARY;
import static org.jreleaser.model.Distribution.DistributionType.JAVA_BINARY;
import static org.jreleaser.model.Distribution.DistributionType.JLINK;
import static org.jreleaser.model.Distribution.DistributionType.NATIVE_IMAGE;
import static org.jreleaser.model.api.packagers.SpecPackager.SKIP_SPEC;
import static org.jreleaser.model.api.packagers.SpecPackager.TYPE;
import static org.jreleaser.util.CollectionUtils.setOf;
import static org.jreleaser.util.FileType.TAR;
import static org.jreleaser.util.FileType.TAR_BZ2;
import static org.jreleaser.util.FileType.TAR_GZ;
import static org.jreleaser.util.FileType.TAR_XZ;
import static org.jreleaser.util.FileType.TBZ2;
import static org.jreleaser.util.FileType.TGZ;
import static org.jreleaser.util.FileType.TXZ;
import static org.jreleaser.util.FileType.ZIP;
import static org.jreleaser.util.StringUtils.isBlank;
import static org.jreleaser.util.StringUtils.isFalse;

/**
 * @author Andres Almiray
 * @since 0.9.1
 */
public final class SpecPackager extends AbstractRepositoryPackager<org.jreleaser.model.api.packagers.SpecPackager, SpecPackager> {
    private static final Map<org.jreleaser.model.Distribution.DistributionType, Set<String>> SUPPORTED = new LinkedHashMap<>();
    private static final long serialVersionUID = 3054130455318535496L;

    static {
        Set<String> extensions = setOf(
            TAR_BZ2.extension(),
            TAR_GZ.extension(),
            TAR_XZ.extension(),
            TBZ2.extension(),
            TGZ.extension(),
            TXZ.extension(),
            TAR.extension(),
            ZIP.extension());

        SUPPORTED.put(NATIVE_IMAGE, extensions);
        SUPPORTED.put(BINARY, extensions);
        SUPPORTED.put(JAVA_BINARY, extensions);
        SUPPORTED.put(JLINK, extensions);
        SUPPORTED.put(FLAT_BINARY, emptySet());
    }

    private final List<String> requires = new ArrayList<>();
    private final SpecRepository repository = new SpecRepository();

    private String packageName;
    private String release;

    @JsonIgnore
    private final org.jreleaser.model.api.packagers.SpecPackager immutable = new org.jreleaser.model.api.packagers.SpecPackager() {
        private static final long serialVersionUID = -457526873236886772L;

        @Override
        public String getPackageName() {
            return packageName;
        }

        @Override
        public String getRelease() {
            return release;
        }

        @Override
        public org.jreleaser.model.api.packagers.PackagerRepository getRepository() {
            return repository.asImmutable();
        }

        @Override
        public List<String> getRequires() {
            return unmodifiableList(requires);
        }

        @Override
        public org.jreleaser.model.api.packagers.PackagerRepository getPackagerRepository() {
            return getRepository();
        }

        @Override
        public org.jreleaser.model.api.common.CommitAuthor getCommitAuthor() {
            return SpecPackager.this.getCommitAuthor().asImmutable();
        }

        @Override
        public String getTemplateDirectory() {
            return SpecPackager.this.getTemplateDirectory();
        }

        @Override
        public List<String> getSkipTemplates() {
            return unmodifiableList(SpecPackager.this.getSkipTemplates());
        }

        @Override
        public String getType() {
            return SpecPackager.this.getType();
        }

        @Override
        public String getDownloadUrl() {
            return SpecPackager.this.getDownloadUrl();
        }

        @Override
        public boolean supportsPlatform(String platform) {
            return SpecPackager.this.supportsPlatform(platform);
        }

        @Override
        public boolean supportsDistribution(Distribution.DistributionType distributionType) {
            return SpecPackager.this.supportsDistribution(distributionType);
        }

        @Override
        public Set<String> getSupportedFileExtensions(Distribution.DistributionType distributionType) {
            return SpecPackager.this.getSupportedFileExtensions(distributionType);
        }

        @Override
        public Set<Stereotype> getSupportedStereotypes() {
            return SpecPackager.this.getSupportedStereotypes();
        }

        @Override
        public boolean isSnapshotSupported() {
            return SpecPackager.this.isSnapshotSupported();
        }

        @Override
        public boolean isContinueOnError() {
            return SpecPackager.this.isContinueOnError();
        }

        @Override
        public boolean isSkipPublishing() {
            return SpecPackager.this.isSkipPublishing();
        }

        @Override
        public Active getActive() {
            return SpecPackager.this.getActive();
        }

        @Override
        public boolean isEnabled() {
            return SpecPackager.this.isEnabled();
        }

        @Override
        public Map<String, Object> asMap(boolean full) {
            return unmodifiableMap(SpecPackager.this.asMap(full));
        }

        @Override
        public String getPrefix() {
            return SpecPackager.this.prefix();
        }

        @Override
        public Map<String, Object> getExtraProperties() {
            return unmodifiableMap(SpecPackager.this.getExtraProperties());
        }
    };

    public SpecPackager() {
        super(TYPE);
    }

    @Override
    public org.jreleaser.model.api.packagers.SpecPackager asImmutable() {
        return immutable;
    }

    @Override
    public void merge(SpecPackager source) {
        super.merge(source);
        this.packageName = merge(this.packageName, source.packageName);
        this.release = merge(this.release, source.release);
        setRepository(source.repository);
        setRequires(merge(this.requires, source.requires));
    }

    public String getPackageName() {
        return packageName;
    }

    public void setPackageName(String packageName) {
        this.packageName = packageName;
    }

    public String getRelease() {
        return release;
    }

    public void setRelease(String release) {
        this.release = release;
    }

    public SpecRepository getRepository() {
        return repository;
    }

    public void setRepository(SpecRepository repository) {
        this.repository.merge(repository);
    }

    public List<String> getRequires() {
        return requires;
    }

    public void setRequires(List<String> requires) {
        this.requires.clear();
        this.requires.addAll(requires);
    }

    @Override
    protected void asMap(boolean full, Map<String, Object> props) {
        super.asMap(full, props);
        props.put("packageName", packageName);
        props.put("release", release);
        props.put("requires", requires);
        props.put("repository", repository.asMap(full));
    }

    @Override
    public RepositoryTap getRepositoryTap() {
        return getPackagerRepository();
    }

    public PackagerRepository getPackagerRepository() {
        return getRepository();
    }

    @Override
    public boolean supportsPlatform(String platform) {
        return isBlank(platform) ||
            PlatformUtils.isLinux(platform) && PlatformUtils.isIntel(platform) && !PlatformUtils.isAlpineLinux(platform);
    }

    @Override
    public boolean supportsDistribution(org.jreleaser.model.Distribution.DistributionType distributionType) {
        return SUPPORTED.containsKey(distributionType);
    }

    @Override
    public Set<String> getSupportedFileExtensions(org.jreleaser.model.Distribution.DistributionType distributionType) {
        return unmodifiableSet(SUPPORTED.getOrDefault(distributionType, emptySet()));
    }

    @Override
    protected boolean isNotSkipped(Artifact artifact) {
        return isFalse(artifact.getExtraProperties().get(SKIP_SPEC));
    }

    public static final class SpecRepository extends PackagerRepository {
        private static final long serialVersionUID = -4727714362653863706L;

        public SpecRepository() {
            super("spec", "spec");
        }
    }
}

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.model.internal.packagers;
19
20	import com.fasterxml.jackson.annotation.JsonIgnore;
21	import org.jreleaser.model.Active;
22	import org.jreleaser.model.Distribution;
23	import org.jreleaser.model.Stereotype;
24	import org.jreleaser.model.internal.common.Artifact;
25	import org.jreleaser.util.PlatformUtils;
26
27	import java.util.ArrayList;
28	import java.util.LinkedHashMap;
29	import java.util.List;
30	import java.util.Map;
31	import java.util.Set;
32
33	import static java.util.Collections.emptySet;
34	import static java.util.Collections.unmodifiableList;
35	import static java.util.Collections.unmodifiableMap;
36	import static java.util.Collections.unmodifiableSet;
37	import static org.jreleaser.model.Distribution.DistributionType.BINARY;
38	import static org.jreleaser.model.Distribution.DistributionType.FLAT_BINARY;
39	import static org.jreleaser.model.Distribution.DistributionType.JAVA_BINARY;
40	import static org.jreleaser.model.Distribution.DistributionType.JLINK;
41	import static org.jreleaser.model.Distribution.DistributionType.NATIVE_IMAGE;
42	import static org.jreleaser.model.api.packagers.SpecPackager.SKIP_SPEC;
43	import static org.jreleaser.model.api.packagers.SpecPackager.TYPE;
44	import static org.jreleaser.util.CollectionUtils.setOf;
45	import static org.jreleaser.util.FileType.TAR;
46	import static org.jreleaser.util.FileType.TAR_BZ2;
47	import static org.jreleaser.util.FileType.TAR_GZ;
48	import static org.jreleaser.util.FileType.TAR_XZ;
49	import static org.jreleaser.util.FileType.TBZ2;
50	import static org.jreleaser.util.FileType.TGZ;
51	import static org.jreleaser.util.FileType.TXZ;
52	import static org.jreleaser.util.FileType.ZIP;
53	import static org.jreleaser.util.StringUtils.isBlank;
54	import static org.jreleaser.util.StringUtils.isFalse;
55
56	/**
57	* @author Andres Almiray
58	* @since 0.9.1
59	*/
60	public final class SpecPackager extends AbstractRepositoryPackager<org.jreleaser.model.api.packagers.SpecPackager, SpecPackager> {
61	private static final Map<org.jreleaser.model.Distribution.DistributionType, Set<String>> SUPPORTED = new LinkedHashMap<>();	1✔
62	private static final long serialVersionUID = 3054130455318535496L;
63
64	static {
65	Set<String> extensions = setOf(	1✔
66	TAR_BZ2.extension(),	1✔
67	TAR_GZ.extension(),	1✔
68	TAR_XZ.extension(),	1✔
69	TBZ2.extension(),	1✔
70	TGZ.extension(),	1✔
71	TXZ.extension(),	1✔
72	TAR.extension(),	1✔
73	ZIP.extension());	1✔
74
75	SUPPORTED.put(NATIVE_IMAGE, extensions);	1✔
76	SUPPORTED.put(BINARY, extensions);	1✔
77	SUPPORTED.put(JAVA_BINARY, extensions);	1✔
78	SUPPORTED.put(JLINK, extensions);	1✔
79	SUPPORTED.put(FLAT_BINARY, emptySet());	1✔
80	}	1✔
81
82	private final List<String> requires = new ArrayList<>();	1✔
83	private final SpecRepository repository = new SpecRepository();	1✔
84
85	private String packageName;
86	private String release;
87
88	@JsonIgnore	1✔
89	private final org.jreleaser.model.api.packagers.SpecPackager immutable = new org.jreleaser.model.api.packagers.SpecPackager() {	1✔
90	private static final long serialVersionUID = -457526873236886772L;
91
92	@Override
93	public String getPackageName() {
94	return packageName;	×
95	}
96
97	@Override
98	public String getRelease() {
99	return release;	×
100	}
101
102	@Override
103	public org.jreleaser.model.api.packagers.PackagerRepository getRepository() {
104	return repository.asImmutable();	×
105	}
106
107	@Override
108	public List<String> getRequires() {
109	return unmodifiableList(requires);	×
110	}
111
112	@Override
113	public org.jreleaser.model.api.packagers.PackagerRepository getPackagerRepository() {
114	return getRepository();	×
115	}
116
117	@Override
118	public org.jreleaser.model.api.common.CommitAuthor getCommitAuthor() {
119	return SpecPackager.this.getCommitAuthor().asImmutable();	×
120	}
121
122	@Override
123	public String getTemplateDirectory() {
124	return SpecPackager.this.getTemplateDirectory();	×
125	}
126
127	@Override
128	public List<String> getSkipTemplates() {
129	return unmodifiableList(SpecPackager.this.getSkipTemplates());	×
130	}
131
132	@Override
133	public String getType() {
134	return SpecPackager.this.getType();	×
135	}
136
137	@Override
138	public String getDownloadUrl() {
139	return SpecPackager.this.getDownloadUrl();	×
140	}
141
142	@Override
143	public boolean supportsPlatform(String platform) {
144	return SpecPackager.this.supportsPlatform(platform);	×
145	}
146
147	@Override
148	public boolean supportsDistribution(Distribution.DistributionType distributionType) {
149	return SpecPackager.this.supportsDistribution(distributionType);	×
150	}
151
152	@Override
153	public Set<String> getSupportedFileExtensions(Distribution.DistributionType distributionType) {
154	return SpecPackager.this.getSupportedFileExtensions(distributionType);	×
155	}
156
157	@Override
158	public Set<Stereotype> getSupportedStereotypes() {
159	return SpecPackager.this.getSupportedStereotypes();	×
160	}
161
162	@Override
163	public boolean isSnapshotSupported() {
164	return SpecPackager.this.isSnapshotSupported();	×
165	}
166
167	@Override
168	public boolean isContinueOnError() {
169	return SpecPackager.this.isContinueOnError();	×
170	}
171
172	@Override
173	public boolean isSkipPublishing() {
NEW 174	return SpecPackager.this.isSkipPublishing();	×
175	}
176
177	@Override
178	public Active getActive() {
179	return SpecPackager.this.getActive();	×
180	}
181
182	@Override
183	public boolean isEnabled() {
184	return SpecPackager.this.isEnabled();	×
185	}
186
187	@Override
188	public Map<String, Object> asMap(boolean full) {
189	return unmodifiableMap(SpecPackager.this.asMap(full));	×
190	}
191
192	@Override
193	public String getPrefix() {
194	return SpecPackager.this.prefix();	×
195	}
196
197	@Override
198	public Map<String, Object> getExtraProperties() {
199	return unmodifiableMap(SpecPackager.this.getExtraProperties());	×
200	}
201	};
202
203	public SpecPackager() {
204	super(TYPE);	1✔
205	}	1✔
206
207	@Override
208	public org.jreleaser.model.api.packagers.SpecPackager asImmutable() {
209	return immutable;	1✔
210	}
211
212	@Override
213	public void merge(SpecPackager source) {
214	super.merge(source);	1✔
215	this.packageName = merge(this.packageName, source.packageName);	1✔
216	this.release = merge(this.release, source.release);	1✔
217	setRepository(source.repository);	1✔
218	setRequires(merge(this.requires, source.requires));	1✔
219	}	1✔
220
221	public String getPackageName() {
222	return packageName;	1✔
223	}
224
225	public void setPackageName(String packageName) {
226	this.packageName = packageName;	1✔
227	}	1✔
228
229	public String getRelease() {
230	return release;	1✔
231	}
232
233	public void setRelease(String release) {
234	this.release = release;	1✔
235	}	1✔
236
237	public SpecRepository getRepository() {
238	return repository;	1✔
239	}
240
241	public void setRepository(SpecRepository repository) {
242	this.repository.merge(repository);	1✔
243	}	1✔
244
245	public List<String> getRequires() {
246	return requires;	1✔
247	}
248
249	public void setRequires(List<String> requires) {
250	this.requires.clear();	1✔
251	this.requires.addAll(requires);	1✔
252	}	1✔
253
254	@Override
255	protected void asMap(boolean full, Map<String, Object> props) {
256	super.asMap(full, props);	1✔
257	props.put("packageName", packageName);	1✔
258	props.put("release", release);	1✔
259	props.put("requires", requires);	1✔
260	props.put("repository", repository.asMap(full));	1✔
261	}	1✔
262
263	@Override
264	public RepositoryTap getRepositoryTap() {
265	return getPackagerRepository();	1✔
266	}
267
268	public PackagerRepository getPackagerRepository() {
269	return getRepository();	1✔
270	}
271
272	@Override
273	public boolean supportsPlatform(String platform) {
274	return isBlank(platform) \|\|	1✔
275	PlatformUtils.isLinux(platform) && PlatformUtils.isIntel(platform) && !PlatformUtils.isAlpineLinux(platform);	1✔
276	}
277
278	@Override
279	public boolean supportsDistribution(org.jreleaser.model.Distribution.DistributionType distributionType) {
280	return SUPPORTED.containsKey(distributionType);	1✔
281	}
282
283	@Override
284	public Set<String> getSupportedFileExtensions(org.jreleaser.model.Distribution.DistributionType distributionType) {
285	return unmodifiableSet(SUPPORTED.getOrDefault(distributionType, emptySet()));	1✔
286	}
287
288	@Override
289	protected boolean isNotSkipped(Artifact artifact) {
290	return isFalse(artifact.getExtraProperties().get(SKIP_SPEC));	1✔
291	}
292
293	public static final class SpecRepository extends PackagerRepository {
294	private static final long serialVersionUID = -4727714362653863706L;
295
296	public SpecRepository() {
297	super("spec", "spec");	1✔
298	}	1✔
299	}
300	}

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