#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

45.61

/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/packagers/GofishPackager.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.JAVA_BINARY;
import static org.jreleaser.model.Distribution.DistributionType.JLINK;
import static org.jreleaser.model.api.packagers.GofishPackager.SKIP_GOFISH;
import static org.jreleaser.model.api.packagers.GofishPackager.TYPE;
import static org.jreleaser.util.CollectionUtils.setOf;
import static org.jreleaser.util.FileType.TAR;
import static org.jreleaser.util.FileType.TAR_GZ;
import static org.jreleaser.util.FileType.TAR_XZ;
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.10.0
 */
public final class GofishPackager extends AbstractRepositoryPackager<org.jreleaser.model.api.packagers.GofishPackager, GofishPackager> {
    private static final Map<org.jreleaser.model.Distribution.DistributionType, Set<String>> SUPPORTED = new LinkedHashMap<>();
    private static final long serialVersionUID = -4053286282850852250L;

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

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

    private final GofishRepository repository = new GofishRepository();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    public GofishPackager() {
        super(TYPE);
    }

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

    @Override
    public void merge(GofishPackager source) {
        super.merge(source);
        setRepository(source.repository);
    }

    public GofishRepository getRepository() {
        return repository;
    }

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

    @Override
    protected void asMap(boolean full, Map<String, Object> props) {
        super.asMap(full, props);
        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.isMac(platform) ||
            PlatformUtils.isWindows(platform) ||
            PlatformUtils.isLinux(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_GOFISH));
    }

    public static final class GofishRepository extends PackagerRepository {
        private static final long serialVersionUID = 2534363121328369670L;

        public GofishRepository() {
            super("gofish", "fish-food");
        }
    }
}

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.JAVA_BINARY;
38	import static org.jreleaser.model.Distribution.DistributionType.JLINK;
39	import static org.jreleaser.model.api.packagers.GofishPackager.SKIP_GOFISH;
40	import static org.jreleaser.model.api.packagers.GofishPackager.TYPE;
41	import static org.jreleaser.util.CollectionUtils.setOf;
42	import static org.jreleaser.util.FileType.TAR;
43	import static org.jreleaser.util.FileType.TAR_GZ;
44	import static org.jreleaser.util.FileType.TAR_XZ;
45	import static org.jreleaser.util.FileType.TGZ;
46	import static org.jreleaser.util.FileType.TXZ;
47	import static org.jreleaser.util.FileType.ZIP;
48	import static org.jreleaser.util.StringUtils.isBlank;
49	import static org.jreleaser.util.StringUtils.isFalse;
50
51	/**
52	* @author Andres Almiray
53	* @since 0.10.0
54	*/
55	public final class GofishPackager extends AbstractRepositoryPackager<org.jreleaser.model.api.packagers.GofishPackager, GofishPackager> {
56	private static final Map<org.jreleaser.model.Distribution.DistributionType, Set<String>> SUPPORTED = new LinkedHashMap<>();	1✔
57	private static final long serialVersionUID = -4053286282850852250L;
58
59	static {
60	Set<String> extensions = setOf(	1✔
61	TAR_GZ.extension(),	1✔
62	TAR_XZ.extension(),	1✔
63	TGZ.extension(),	1✔
64	TXZ.extension(),	1✔
65	TAR.extension(),	1✔
66	ZIP.extension());	1✔
67
68	SUPPORTED.put(BINARY, extensions);	1✔
69	SUPPORTED.put(JAVA_BINARY, extensions);	1✔
70	SUPPORTED.put(JLINK, extensions);	1✔
71	}	1✔
72
73	private final GofishRepository repository = new GofishRepository();	1✔
74
75	@JsonIgnore	1✔
76	private final org.jreleaser.model.api.packagers.GofishPackager immutable = new org.jreleaser.model.api.packagers.GofishPackager() {	1✔
77	private static final long serialVersionUID = 5164825472096915255L;
78
79	@Override
80	public org.jreleaser.model.api.packagers.PackagerRepository getRepository() {
81	return repository.asImmutable();	×
82	}
83
84	@Override
85	public org.jreleaser.model.api.packagers.PackagerRepository getPackagerRepository() {
86	return getRepository();	×
87	}
88
89	@Override
90	public org.jreleaser.model.api.common.CommitAuthor getCommitAuthor() {
91	return GofishPackager.this.getCommitAuthor().asImmutable();	×
92	}
93
94	@Override
95	public String getTemplateDirectory() {
96	return GofishPackager.this.getTemplateDirectory();	×
97	}
98
99	@Override
100	public List<String> getSkipTemplates() {
101	return unmodifiableList(GofishPackager.this.getSkipTemplates());	×
102	}
103
104	@Override
105	public String getType() {
106	return GofishPackager.this.getType();	×
107	}
108
109	@Override
110	public String getDownloadUrl() {
111	return GofishPackager.this.getDownloadUrl();	×
112	}
113
114	@Override
115	public boolean supportsPlatform(String platform) {
116	return GofishPackager.this.supportsPlatform(platform);	×
117	}
118
119	@Override
120	public boolean supportsDistribution(Distribution.DistributionType distributionType) {
121	return GofishPackager.this.supportsDistribution(distributionType);	×
122	}
123
124	@Override
125	public Set<String> getSupportedFileExtensions(Distribution.DistributionType distributionType) {
126	return GofishPackager.this.getSupportedFileExtensions(distributionType);	×
127	}
128
129	@Override
130	public Set<Stereotype> getSupportedStereotypes() {
131	return GofishPackager.this.getSupportedStereotypes();	×
132	}
133
134	@Override
135	public boolean isSnapshotSupported() {
136	return GofishPackager.this.isSnapshotSupported();	×
137	}
138
139	@Override
140	public boolean isContinueOnError() {
141	return GofishPackager.this.isContinueOnError();	×
142	}
143
144	@Override
145	public boolean isSkipPublishing() {
NEW 146	return GofishPackager.this.isSkipPublishing();	×
147	}
148
149	@Override
150	public Active getActive() {
151	return GofishPackager.this.getActive();	×
152	}
153
154	@Override
155	public boolean isEnabled() {
156	return GofishPackager.this.isEnabled();	×
157	}
158
159	@Override
160	public Map<String, Object> asMap(boolean full) {
161	return unmodifiableMap(GofishPackager.this.asMap(full));	×
162	}
163
164	@Override
165	public String getPrefix() {
166	return GofishPackager.this.prefix();	×
167	}
168
169	@Override
170	public Map<String, Object> getExtraProperties() {
171	return unmodifiableMap(GofishPackager.this.getExtraProperties());	×
172	}
173	};
174
175	public GofishPackager() {
176	super(TYPE);	1✔
177	}	1✔
178
179	@Override
180	public org.jreleaser.model.api.packagers.GofishPackager asImmutable() {
181	return immutable;	×
182	}
183
184	@Override
185	public void merge(GofishPackager source) {
186	super.merge(source);	×
187	setRepository(source.repository);	×
188	}	×
189
190	public GofishRepository getRepository() {
191	return repository;	1✔
192	}
193
194	public void setRepository(GofishRepository repository) {
195	this.repository.merge(repository);	×
196	}	×
197
198	@Override
199	protected void asMap(boolean full, Map<String, Object> props) {
200	super.asMap(full, props);	1✔
201	props.put("repository", repository.asMap(full));	1✔
202	}	1✔
203
204	@Override
205	public RepositoryTap getRepositoryTap() {
206	return getPackagerRepository();	1✔
207	}
208
209	public PackagerRepository getPackagerRepository() {
210	return getRepository();	1✔
211	}
212
213	@Override
214	public boolean supportsPlatform(String platform) {
215	return isBlank(platform) \|\|	×
216	PlatformUtils.isMac(platform) \|\|	×
217	PlatformUtils.isWindows(platform) \|\|	×
218	PlatformUtils.isLinux(platform) && !PlatformUtils.isAlpineLinux(platform);	×
219	}
220
221	@Override
222	public boolean supportsDistribution(org.jreleaser.model.Distribution.DistributionType distributionType) {
223	return SUPPORTED.containsKey(distributionType);	1✔
224	}
225
226	@Override
227	public Set<String> getSupportedFileExtensions(org.jreleaser.model.Distribution.DistributionType distributionType) {
228	return unmodifiableSet(SUPPORTED.getOrDefault(distributionType, emptySet()));	×
229	}
230
231	@Override
232	protected boolean isNotSkipped(Artifact artifact) {
233	return isFalse(artifact.getExtraProperties().get(SKIP_GOFISH));	×
234	}
235
236	public static final class GofishRepository extends PackagerRepository {
237	private static final long serialVersionUID = 2534363121328369670L;
238
239	public GofishRepository() {
240	super("gofish", "fish-food");	1✔
241	}	1✔
242	}
243	}

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