diff --git a/README.md b/README.md index 27cf8ac..6aae1a3 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ The task will first check if the stack already exists and if it does it will upd Stack parameter names in the Cloudformation template is usually in PascalCase but in Gradle you usually use camelCase. So the task will convert the parameter names to be in PascalCase for you. -The task can also filter out specific parameters give a name prefix. See below example. +The task can also filters out specific parameters given a name prefix. See below example. The task will inline the Cloudformation template in the request to AWS. So it will not for instance store it in an S3 bucket. This means that the template can't be bigger than 51,200 bytes. @@ -105,7 +105,7 @@ The task definition which takes the name of the properties file as a command lin task deployS3Stack(type: se.solrike.cloudformation.CreateOrUpdateStackTask) { group = 'AWS' description = 'Create S3 buckets using Cloudformation template. ' + - 'Specify the enviroment to use with -Penv=.' + 'Specify the environment to use with -Penv=.' parameters = project.objects.mapProperty(String, String).convention(project.provider({ Properties props = new Properties() file("environments/${env}.properties").withInputStream { props.load(it) } diff --git a/build.gradle b/build.gradle index 50091b2..d74ab52 100644 --- a/build.gradle +++ b/build.gradle @@ -17,7 +17,6 @@ dependencies { implementation 'org.ajoberstar.grgit:grgit-core:5.0.0' def awsSdkVersion = '2.17.292' implementation "software.amazon.awssdk:cloudformation:$awsSdkVersion" - //implementation "software.amazon.awssdk:sdk-core:$awsSdkVersion" testImplementation 'org.mockito:mockito-core:3.7.7' testImplementation 'org.mockito:mockito-junit-jupiter:3.7.7' @@ -33,28 +32,30 @@ targetCompatibility = '11' tasks.withType(GroovyCompile) { configure(options) { - options.compilerArgs << '-Xlint:deprecation' << '-Xlint:unchecked' + options.compilerArgs << '-Xlint:deprecation' << '-Xlint:unchecked' } } sourceSets { main { - java { - srcDirs = [] // don't compile Java code twice - } - groovy { - srcDirs = [ 'src/main/groovy', 'src/main/java' ] - } + java { + srcDirs = [] // don't compile Java code twice + } + groovy { + srcDirs = [ + 'src/main/groovy', + 'src/main/java' + ] + } } test { java { - srcDirs = [] // don't compile Java code twice + srcDirs = [] // don't compile Java code twice } groovy { - srcDirs = [ 'src/test/groovy'] + srcDirs = ['src/test/groovy'] } -} - + } } javadoc { @@ -87,7 +88,9 @@ pluginBundle { // tags and description can be set for the whole bundle here, but can also // be set / overridden in the config for specific plugins - description = 'Deploys AWS Cloudformation stacks from a template. Min Gradle version 7.0.' + description = 'Gradle plugin for create/update and delete AWS Cloudformation stacks. ' + + 'The parameters for the Cloudformation template can be managed per environment and kept ' + + 'in for instance Java properties files. Min Gradle version 7.0.' // The plugins block can contain multiple plugin entries. The name for // each plugin block below (greetingsPlugin, goodbyePlugin)does not @@ -102,7 +105,7 @@ pluginBundle { cloudformationPlugin { // id is captured from java-gradle-plugin configuration displayName = 'Cloudformation plugin' - tags = ['Cloudformation', 'AWS' ] + tags = ['Cloudformation', 'AWS'] } } }