Skip to content

add new parameter failOnError, which can be set to fail builds #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bnasslahsen merged 3 commits into from
May 4, 2025
Merged

add new parameter failOnError, which can be set to fail builds #60

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d532e81
add new parameter `failOnError`, which can be set to fail builds if e…
timbuethe Jun 3, 2023
7ae8da1
Merge branch 'springdoc:master' into master
timbuethe Feb 1, 2024
9d0657f
also fail on any exception
timbuethe Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/main/java/org/springdoc/maven/plugin/SpringDocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import java.util.Map;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
Expand Down Expand Up @@ -80,6 +81,12 @@ public class SpringDocMojo extends AbstractMojo {
@Parameter(defaultValue = "false", property = "springdoc.skip")
private boolean skip;

/**
* Fail build on error, if set to true. Default is false.
*/
@Parameter(defaultValue = "false", property = "springdoc.failOnError")
private boolean failOnError;

/**
* Headers to send in request
*/
Expand All @@ -97,7 +104,7 @@ public class SpringDocMojo extends AbstractMojo {
*/
private static final String GET = "GET";

public void execute() {
public void execute() throws MojoFailureException {
if (skip) {
getLog().info("Skip execution as per configuration");
return;
Expand All @@ -114,10 +121,18 @@ public void execute() {
Files.write(Paths.get(outputDir.getAbsolutePath() + "/" + outputFileName), result.getBytes(StandardCharsets.UTF_8));
if (attachArtifact) addArtifactToMaven();
} else {
getLog().error("An error has occurred: Response code " + responseCode);
String message = "An error has occurred, response code: " + responseCode;
if(failOnError) {
throw new MojoFailureException(message);
} else {
getLog().error(message);
}
}
} catch (Exception e) {
getLog().error("An error has occurred", e);
if(failOnError) {
throw new MojoFailureException("An error has occurred: " + e.getMessage());
}
}
}

Expand Down