#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

66.67

/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/packagers/ScoopPackager.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.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.Distribution.DistributionType.NATIVE_PACKAGE;
import static org.jreleaser.model.Distribution.DistributionType.SINGLE_JAR;
import static org.jreleaser.model.JReleaserOutput.nag;
import static org.jreleaser.model.api.packagers.ScoopPackager.SKIP_SCOOP;
import static org.jreleaser.model.api.packagers.ScoopPackager.TYPE;
import static org.jreleaser.util.CollectionUtils.setOf;
import static org.jreleaser.util.FileType.BAT;
import static org.jreleaser.util.FileType.CMD;
import static org.jreleaser.util.FileType.EXE;
import static org.jreleaser.util.FileType.JAR;
import static org.jreleaser.util.FileType.MSI;
import static org.jreleaser.util.FileType.PS1;
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.1.0
 */
public final class ScoopPackager extends AbstractRepositoryPackager<org.jreleaser.model.api.packagers.ScoopPackager, ScoopPackager> {
    private static final Map<org.jreleaser.model.Distribution.DistributionType, Set<String>> SUPPORTED = new LinkedHashMap<>();
    private static final long serialVersionUID = 7277751575218470373L;

    static {
        Set<String> extensions = setOf(ZIP.extension());
        SUPPORTED.put(NATIVE_IMAGE, extensions);
        SUPPORTED.put(BINARY, extensions);
        SUPPORTED.put(JAVA_BINARY, extensions);
        SUPPORTED.put(JLINK, extensions);
        SUPPORTED.put(NATIVE_PACKAGE, setOf(MSI.extension()));
        SUPPORTED.put(SINGLE_JAR, setOf(JAR.extension()));
        SUPPORTED.put(FLAT_BINARY, setOf(BAT.extension(), CMD.extension(), EXE.extension(), PS1.extension()));
    }

    private final ScoopRepository repository = new ScoopRepository();
    private String packageName;
    private String checkverUrl;
    private String autoupdateUrl;

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

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

        @Override
        public String getCheckverUrl() {
            return checkverUrl;
        }

        @Override
        public String getAutoupdateUrl() {
            return autoupdateUrl;
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    public ScoopPackager() {
        super(TYPE);
    }

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

    @Override
    public void merge(ScoopPackager source) {
        super.merge(source);
        this.packageName = merge(this.packageName, source.packageName);
        this.checkverUrl = merge(this.checkverUrl, source.checkverUrl);
        this.autoupdateUrl = merge(this.autoupdateUrl, source.autoupdateUrl);
        setRepository(source.repository);
    }

    public String getPackageName() {
        return packageName;
    }

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

    public String getCheckverUrl() {
        return checkverUrl;
    }

    public void setCheckverUrl(String checkverUrl) {
        this.checkverUrl = checkverUrl;
    }

    public String getAutoupdateUrl() {
        return autoupdateUrl;
    }

    public void setAutoupdateUrl(String autoupdateUrl) {
        this.autoupdateUrl = autoupdateUrl;
    }

    public ScoopRepository getRepository() {
        return repository;
    }

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

    @Deprecated
    public ScoopRepository getBucket() {
        return getRepository();
    }

    @Deprecated
    public void setBucket(ScoopRepository repository) {
        nag("scoop.bucket is deprecated since 1.8.0 and will be removed in 2.0.0. Use scoop.repository instead");
        setRepository(repository);
    }

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

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

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

    @Override
    public boolean supportsPlatform(String platform) {
        return isBlank(platform) || PlatformUtils.isWindows(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_SCOOP));
    }

    public static final class ScoopRepository extends PackagerRepository {
        private static final long serialVersionUID = 5693815301518572010L;

        public ScoopRepository() {
            super("scoop", "scoop");
        }
    }
}

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

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