refactor(github): Rename generate to enabled for consistency. Relates…

… to #879
jreleaser · Aug 9, 2022 · 346cb90 · 346cb90
1 parent fef49ae
commit 346cb90
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 17 deletions.
diff --git a/core/jreleaser-model/src/main/java/org/jreleaser/model/Github.java b/core/jreleaser-model/src/main/java/org/jreleaser/model/Github.java
@@ -105,24 +105,31 @@ public Map<String, Object> asMap(boolean full) {
         return map;
     }
 
-    public static class ReleaseNotes extends AbstractModelObject<ReleaseNotes> implements Domain {
-        private Boolean generate;
+    public static class ReleaseNotes extends AbstractModelObject<ReleaseNotes> implements Domain, EnabledAware {
+        private Boolean enabled;
         private String configurationFile;
 
         @Override
         public void merge(ReleaseNotes source) {
             freezeCheck();
-            this.generate = merge(this.generate, source.generate);
+            this.enabled = merge(this.enabled, source.enabled);
             this.configurationFile = merge(this.configurationFile, source.configurationFile);
         }
 
-        public Boolean isGenerate() {
-            return generate != null && generate;
+        @Override
+        public boolean isEnabled() {
+            return enabled != null && enabled;
         }
 
-        public void setGenerate(Boolean generate) {
+        @Override
+        public void setEnabled(Boolean enabled) {
             freezeCheck();
-            this.generate = generate;
+            this.enabled = enabled;
+        }
+
+        @Override
+        public boolean isEnabledSet() {
+            return enabled != null;
         }
 
         public String getConfigurationFile() {
@@ -137,7 +144,7 @@ public void setConfigurationFile(String configurationFile) {
         @Override
         public Map<String, Object> asMap(boolean full) {
             Map<String, Object> map = new LinkedHashMap<>();
-            map.put("generate", isGenerate());
+            map.put("enabled", isEnabled());
             map.put("configurationFile", configurationFile);
             return map;
         }

diff --git a/core/jreleaser-model/src/main/java/org/jreleaser/model/validation/GitServiceValidator.java b/core/jreleaser-model/src/main/java/org/jreleaser/model/validation/GitServiceValidator.java
@@ -200,7 +200,7 @@ public static void validateGitService(JReleaserContext context, JReleaserContext
             boolean generate = false;
             if (service instanceof Github) {
                 Github gh = (Github) service;
-                generate = gh.getReleaseNotes().isGenerate();
+                generate = gh.getReleaseNotes().isEnabled();
             }
 
             if (!generate) {
@@ -217,7 +217,7 @@ public static void validateGitService(JReleaserContext context, JReleaserContext
             boolean generate = false;
             if (service instanceof Github) {
                 Github gh = (Github) service;
-                generate = gh.getReleaseNotes().isGenerate();
+                generate = gh.getReleaseNotes().isEnabled();
             }
 
             if (!generate) {
@@ -262,7 +262,7 @@ private static void validateChangelog(JReleaserContext context, GitService servi
         // Special case for GitHub
         if (service instanceof Github) {
             Github gh = (Github) service;
-            boolean generate = gh.getReleaseNotes().isGenerate();
+            boolean generate = gh.getReleaseNotes().isEnabled();
 
             if (generate && changelog.isEnabled()) {
                 errors.configuration(RB.$("validation_github_releasenotes_changelog"));

diff --git a/...ins/jreleaser-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/dsl/Github.groovy b/...ins/jreleaser-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/dsl/Github.groovy
@@ -46,7 +46,7 @@ interface Github extends GitService {
 
     @CompileStatic
     interface ReleaseNotes {
-        Property<Boolean> getGenerate()
+        Property<Boolean> getEnabled()
 
         Property<String> getConfigurationFile()
     }

diff --git a/...-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/internal/dsl/GithubImpl.groovy b/...-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/internal/dsl/GithubImpl.groovy
@@ -104,24 +104,24 @@ class GithubImpl extends AbstractGitService implements Github {
 
     @CompileStatic
     static class ReleaseNotesImpl implements ReleaseNotes {
-        final Property<Boolean> generate
+        final Property<Boolean> enabled
         final Property<String> configurationFile
 
         @Inject
         ReleaseNotesImpl(ObjectFactory objects) {
-            generate = objects.property(Boolean).convention(Providers.notDefined())
+            enabled = objects.property(Boolean).convention(Providers.notDefined())
             configurationFile = objects.property(String).convention(Providers.notDefined())
         }
 
         @Internal
         boolean isSet() {
-            generate.present ||
+            enabled.present ||
                 configurationFile.present
         }
 
         org.jreleaser.model.Github.ReleaseNotes toModel() {
             org.jreleaser.model.Github.ReleaseNotes releaseNotes = new org.jreleaser.model.Github.ReleaseNotes()
-            if (generate.present) releaseNotes.generate = generate.get()
+            if (enabled.present) releaseNotes.enabled = enabled.get()
             if (configurationFile.present) releaseNotes.configurationFile = configurationFile.get()
             releaseNotes
         }

diff --git a/sdks/github-java-sdk/src/main/java/org/jreleaser/sdk/github/GithubReleaser.java b/sdks/github-java-sdk/src/main/java/org/jreleaser/sdk/github/GithubReleaser.java
@@ -64,7 +64,7 @@ public GithubReleaser(JReleaserContext context, List<Asset> assets) {
     public String generateReleaseNotes() throws IOException {
         org.jreleaser.model.Github github = context.getModel().getRelease().getGithub();
 
-        if (github.getReleaseNotes().isGenerate()) {
+        if (github.getReleaseNotes().isEnabled()) {
             return ChangelogProvider.storeChangelog(context, generateReleaseNotesByAPI());
         }