├── .gitignore ├── src └── main │ ├── resources │ └── META-INF │ │ └── gradle-plugins │ │ └── s3.properties │ └── groovy │ └── com │ └── github │ └── skhatri │ └── s3aws │ ├── plugin │ ├── S3DownloadExtension.groovy │ ├── S3Extension.groovy │ ├── S3UploadExtension.groovy │ ├── S3DownloadTask.groovy │ ├── S3UploadTask.groovy │ └── S3Plugin.groovy │ └── client │ └── S3Client.groovy ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── example ├── README.md ├── gradle-plugins.gradle ├── build.gradle ├── gradle-plugins-legacy.gradle └── local.gradle ├── gradle.properties ├── gradlew.bat ├── README.md └── gradlew /.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | example/build 3 | .gradle 4 | *.iws 5 | *.ipr 6 | *.iml 7 | .idea 8 | 9 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/gradle-plugins/s3.properties: -------------------------------------------------------------------------------- 1 | implementation-class=com.github.skhatri.s3aws.plugin.S3Plugin -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/skhatri/gradle-s3-plugin/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3DownloadExtension.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin; 2 | 3 | public class S3DownloadExtension { 4 | String bucket; 5 | String awsProfile 6 | String key = ""; 7 | String saveTo = ""; 8 | } 9 | 10 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3Extension.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin 2 | 3 | class S3Extension { 4 | String bucket 5 | String awsProfile = 'default' 6 | S3DownloadExtension download = new S3DownloadExtension() 7 | S3UploadExtension upload = new S3UploadExtension() 8 | } 9 | -------------------------------------------------------------------------------- /example/README.md: -------------------------------------------------------------------------------- 1 | 2 | ### S3 tasks using maven repo 3 | gradle -b build.gradle s3Upload 4 | gradle -b build.gradle s3Download 5 | 6 | ### S3 tasks using gradle plugin repo and legacy mode 7 | gradle -b gradle-plugins-legacy.gradle s3Upload 8 | gradle -b gradle-plugins-legacy.gradle s3Download 9 | 10 | ### S3 tasks using gradle plugin repo 11 | gradle -b gradle-plugins.gradle s3Download 12 | gradle -b gradle-plugins.gradle s3Upload 13 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3UploadExtension.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin 2 | 3 | import com.amazonaws.services.s3.model.CannedAccessControlList 4 | import com.amazonaws.services.s3.model.ObjectMetadata 5 | 6 | class S3UploadExtension { 7 | String bucket 8 | String awsProfile 9 | String key = '' 10 | String file = '' 11 | String link = '' 12 | ObjectMetadata metadata = null 13 | CannedAccessControlList acl = null 14 | } 15 | -------------------------------------------------------------------------------- /example/gradle-plugins.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id "com.github.skhatri.s3" version "1.0.7" 3 | } 4 | 5 | s3 { 6 | bucket = 'skhatri-bucket' 7 | //awsProfile = 'default' 8 | upload { 9 | key = 'gradle-plugins/gradle-plugins.gradle' 10 | file = 'gradle-plugins.gradle' 11 | link = 'latest/gradle-plugins.example.gradle' 12 | } 13 | download { 14 | key = 'gradle-plugins/gradle-plugins.gradle' 15 | saveTo = 'gradle-pugin.tmp.gradle' 16 | } 17 | } 18 | 19 | -------------------------------------------------------------------------------- /example/build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | dependencies { 3 | classpath 'com.github.skhatri:gradle-s3-plugin:1.0.6' 4 | } 5 | repositories { 6 | mavenCentral() 7 | } 8 | } 9 | apply plugin: 's3' 10 | 11 | s3 { 12 | bucket = 'skhatri-bucket' 13 | awsProfile = 'skhatri' 14 | upload { 15 | key = 'build.gradle' 16 | file = 'build.gradle' 17 | link = 'latest/build.gradle' 18 | } 19 | download { 20 | key = 'build.gradle' 21 | saveTo = 'tmp.gradle' 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | group=com.github.skhatri 2 | artifact=gradle-s3-plugin 3 | version=1.0.6 4 | 5 | upload.snapshot.url=https://oss.sonatype.org/content/repositories/snapshots 6 | upload.release.url=https://oss.sonatype.org/service/local/staging/deploy/maven2/ 7 | release=true 8 | 9 | #for completeness. store these in your $GRADLE_USER_HOME/gradle.properties 10 | upload.user= 11 | upload.password= 12 | signing.keyId= 13 | signing.secretKeyRingFile= 14 | signing.password= 15 | 16 | #pom 17 | scm.url=https://github.com/skhatri/gradle-s3-plugin.git 18 | author.handle=skhatri 19 | author.name=Suresh Khatri 20 | author.email= 21 | 22 | systemProp.org.gradle.internal.publish.checksums.insecure=true 23 | -------------------------------------------------------------------------------- /example/gradle-plugins-legacy.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | repositories { 3 | maven { 4 | url "https://plugins.gradle.org/m2/" 5 | } 6 | } 7 | dependencies { 8 | classpath "com.github.skhatri:gradle-s3-plugin:1.0.7" 9 | } 10 | } 11 | 12 | apply plugin: "com.github.skhatri.s3" 13 | 14 | s3 { 15 | bucket = 'skhatri-bucket' 16 | //awsProfile = 'default' 17 | upload { 18 | key = 'gradle-plugins/gradle-plugins.gradle' 19 | file = 'gradle-plugins.gradle' 20 | link = 'latest/gradle-plugins.example.gradle' 21 | } 22 | download { 23 | key = 'gradle-plugins/gradle-plugins.gradle' 24 | saveTo = 'gradle-pugin.tmp.gradle' 25 | } 26 | } 27 | 28 | -------------------------------------------------------------------------------- /example/local.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | dependencies { 3 | classpath 'com.github.skhatri:gradle-s3-plugin:1.0.6' 4 | classpath 'com.amazonaws:aws-java-sdk-s3:1.12.68' 5 | } 6 | repositories { 7 | //for local testing 8 | flatDir { 9 | dirs '../build/libs' 10 | } 11 | mavenCentral() 12 | } 13 | } 14 | apply plugin: 's3' 15 | 16 | s3 { 17 | bucket = 'skhatri-bucket' 18 | //awsProfile = 'default' 19 | upload { 20 | key = 'gradle-s3-plugin-1.0.6.jar' 21 | file = '../build/libs/gradle-s3-plugin-1.0.6.jar' 22 | link = 'latest/gradle-plugin.jar' 23 | } 24 | download { 25 | key = 'latest/gradle-plugin.jar' 26 | saveTo = 'gradle-pugin.jar' 27 | } 28 | } 29 | 30 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3DownloadTask.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin 2 | 3 | import com.github.skhatri.s3aws.client.S3Client 4 | import org.gradle.api.DefaultTask 5 | import org.gradle.api.tasks.Input 6 | import org.gradle.api.tasks.TaskAction 7 | 8 | class S3DownloadTask extends DefaultTask { 9 | 10 | @Input 11 | String bucket 12 | @Input 13 | String region 14 | @Input 15 | String awsProfile 16 | @Input 17 | String key 18 | @Input 19 | String saveTo 20 | 21 | public S3DownloadTask() { 22 | bucket = '' 23 | region = '' 24 | awsProfile = '' 25 | } 26 | 27 | @TaskAction 28 | public void perform() { 29 | String bucketName = getBucket() 30 | String regionName = getRegion() 31 | String profileName = getAwsProfile() 32 | 33 | logger.quiet "s3 download " + bucketName 34 | logger.quiet "using region " + regionName 35 | logger.quiet "using aws profile " + profileName 36 | String keyValue = getKey() 37 | if (keyValue == null || keyValue == '') { 38 | return; 39 | } 40 | S3Client client = new S3Client(profileName, regionName) 41 | 42 | String saveTo = getSaveTo() 43 | client.downloadFile(bucketName, keyValue, saveTo) 44 | logger.quiet "Downloaded \"" + keyValue + "\" to \"" + saveTo + "\"" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3UploadTask.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin 2 | 3 | import com.amazonaws.services.s3.model.CannedAccessControlList 4 | import com.amazonaws.services.s3.model.ObjectMetadata 5 | import com.github.skhatri.s3aws.client.S3Client 6 | import org.gradle.api.DefaultTask 7 | import org.gradle.api.tasks.Input 8 | import org.gradle.api.tasks.Optional 9 | import org.gradle.api.tasks.TaskAction 10 | 11 | class S3UploadTask extends DefaultTask { 12 | 13 | @Input 14 | String bucket 15 | @Input 16 | String region 17 | @Input 18 | String awsProfile 19 | @Input 20 | String key 21 | @Input 22 | String file 23 | @Input @Optional 24 | String link 25 | @Input @Optional 26 | ObjectMetadata metadata 27 | @Input @Optional 28 | CannedAccessControlList acl 29 | 30 | public S3UploadTask() { 31 | bucket = '' 32 | region = '' 33 | awsProfile = '' 34 | metadata = null; 35 | } 36 | 37 | @TaskAction 38 | public void perform() { 39 | String bucketName = getBucket() 40 | String regionName = getRegion() 41 | String profileName = getAwsProfile() 42 | 43 | logger.quiet "s3 upload " + bucketName 44 | logger.quiet "using region " + regionName 45 | logger.quiet "using aws profile " + profileName 46 | String fileName = getFile() 47 | if (fileName == null || fileName == '') { 48 | return; 49 | } 50 | String keyValue = getKey() 51 | S3Client client = new S3Client(profileName, regionName) 52 | String presigned = client.uploadFile(bucketName, keyValue, fileName, getLink(), getMetadata(), getAcl()) 53 | logger.quiet "Uploaded \"" + fileName + "\" to \"" + keyValue + "\"" 54 | logger.quiet "Downloadable from " + presigned + " within next 7 days" 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/plugin/S3Plugin.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.plugin 2 | 3 | import org.gradle.api.Plugin 4 | import org.gradle.api.Project 5 | 6 | public class S3Plugin implements Plugin { 7 | void apply(Project project) { 8 | def s3Ext = project.extensions.create('s3', S3Extension) 9 | s3Ext.extensions.create('upload', S3UploadExtension) 10 | s3Ext.extensions.create('download', S3DownloadExtension) 11 | createUploadTask(project) 12 | createDownloadTask(project) 13 | } 14 | 15 | void createUploadTask(Project project) { 16 | project.tasks.create(name: 's3Upload', type: S3UploadTask) { 17 | 18 | } 19 | project.tasks.withType(S3UploadTask) { 20 | def s3Ext = project.extensions.getByName('s3') 21 | def s3UploadExt = s3Ext.extensions.getByName('upload') 22 | 23 | conventionMapping.bucket = { s3Ext.bucket } 24 | conventionMapping.awsProfile = { s3Ext.awsProfile } 25 | conventionMapping.key = { s3UploadExt.key } 26 | if (s3UploadExt.link) { 27 | conventionMapping.link = { s3UploadExt.link } 28 | } 29 | conventionMapping.file = { s3UploadExt.file } 30 | if (s3UploadExt.metadata) { 31 | conventionMapping.metadata = { s3UploadExt.metadata } 32 | } 33 | if (s3UploadExt.acl) { 34 | conventionMapping.acl = { s3UploadExt.acl } 35 | } 36 | } 37 | } 38 | 39 | void createDownloadTask(Project project) { 40 | project.tasks.create(name: 's3Download', type: S3DownloadTask) { 41 | } 42 | 43 | project.tasks.withType(S3DownloadTask) { 44 | def s3Ext = project.extensions.getByName('s3') 45 | def s3DownloadExt = s3Ext.extensions.getByName('download') 46 | conventionMapping.bucket = { s3Ext.bucket } 47 | conventionMapping.awsProfile = { s3Ext.awsProfile } 48 | conventionMapping.key = { s3DownloadExt.key } 49 | conventionMapping.saveTo = { s3DownloadExt.saveTo } 50 | } 51 | } 52 | 53 | } 54 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/groovy/com/github/skhatri/s3aws/client/S3Client.groovy: -------------------------------------------------------------------------------- 1 | package com.github.skhatri.s3aws.client 2 | 3 | import com.amazonaws.auth.DefaultAWSCredentialsProviderChain 4 | import com.amazonaws.auth.profile.ProfileCredentialsProvider 5 | import com.amazonaws.regions.Region 6 | import com.amazonaws.regions.Regions 7 | import com.amazonaws.services.s3.AmazonS3Client 8 | import com.amazonaws.services.s3.model.CannedAccessControlList 9 | import com.amazonaws.services.s3.model.ObjectMetadata 10 | import com.amazonaws.services.s3.model.PutObjectRequest 11 | import com.amazonaws.services.s3.model.S3Object 12 | 13 | import java.time.ZonedDateTime 14 | 15 | public class S3Client { 16 | private final AmazonS3Client s3Client; 17 | 18 | private static final String AMZ_REDIRECT_LINK = "x-amz-website-redirect-location"; 19 | 20 | public S3Client(String awsProfile, String region) { 21 | s3Client = "none".equals(awsProfile) ? 22 | new AmazonS3Client(new DefaultAWSCredentialsProviderChain()) : 23 | new AmazonS3Client(new ProfileCredentialsProvider(awsProfile)); 24 | if (region != null && !"".equals(region)) { 25 | s3Client.setRegion(Region.getRegion(Regions.fromName(region))) 26 | } 27 | } 28 | 29 | public String uploadFile(String bucketName, String key, String fileName, String link, ObjectMetadata metadata, CannedAccessControlList acl) { 30 | try { 31 | PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, new File(fileName)) 32 | 33 | if (metadata != null) { 34 | putObjectRequest.withMetadata(metadata) 35 | } 36 | 37 | if (acl != null) { 38 | putObjectRequest.withCannedAcl(acl) 39 | } 40 | 41 | s3Client.putObject(putObjectRequest) 42 | String linkName = createLinkObject(link, key, bucketName) 43 | if (linkName == null) { 44 | linkName = s3Client.generatePresignedUrl(bucketName, key, Date.from(ZonedDateTime.now().plusDays(7).toInstant())) 45 | } 46 | return linkName 47 | } catch (Exception e) { 48 | throw new RuntimeException("AWS Upload Exception ", e) 49 | } 50 | } 51 | 52 | private String createLinkObject(String link, String key, String bucketName) { 53 | if (link != null && !link.isEmpty()) { 54 | ObjectMetadata metadata = new ObjectMetadata(); 55 | metadata.setHeader(AMZ_REDIRECT_LINK, createRedirectKey(key)); 56 | metadata.setContentLength(0); 57 | InputStream inputStream = new ByteArrayInputStream(new byte[0]); 58 | PutObjectRequest linkPutRequest = new PutObjectRequest(bucketName, link, inputStream, metadata) 59 | linkPutRequest.setCannedAcl(CannedAccessControlList.Private) 60 | s3Client.putObject(linkPutRequest); 61 | return s3Client.generatePresignedUrl(bucketName, link, Date.from(ZonedDateTime.now().plusDays(7).toInstant())); 62 | } 63 | } 64 | 65 | private String createRedirectKey(String key) { 66 | key.startsWith("/") || key.startsWith("http") ? key : "/" + key 67 | } 68 | 69 | public void downloadFile(String bucketName, String key, String saveTo) { 70 | try { 71 | S3Object object = s3Client.getObject(bucketName, key); 72 | String redirect = object.getObjectMetadata().getRawMetadataValue(AMZ_REDIRECT_LINK) 73 | if (redirect != null && !redirect.isEmpty()) { 74 | println "getting redirect resource = $redirect" 75 | object = s3Client.getObject(bucketName, redirect.substring(1)) 76 | } 77 | byte[] bytes = object.getObjectContent().getBytes(); 78 | def fs = new FileOutputStream(new File(saveTo)); 79 | fs.write(bytes); 80 | fs.close(); 81 | } catch (Exception e) { 82 | throw new RuntimeException("AWS Download Exception ", e); 83 | } 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Gradle S3 Plugin 2 | ---------------- 3 | 4 | This plugin can be used to download files from S3 buckets. You can upload artifacts to S3 as well. The link configuration attribute can be used to create amz-website-redirect-location based redirects. Technically this is not a symbolic link, but it can behave like one when trying to reference same file from multiple locations. 5 | 6 | The plugin creates two tasks: 7 | 8 | # s3Upload 9 | As the name suggests, the s3Upload task can be used to upload a local file to a bucket with a given key name. 10 | 11 | # s3Download 12 | Similarly, the s3Download task can be used to download a given file from a chosen bucket to a local directory. 13 | 14 | The plugin uses a ProfileCredentialsProvider strategy to figure out AWS access and secret key. The 15 | name of the credentials profile to use when connecting to AWS can be specified by the awsProfile 16 | propterty. 17 | 18 | See com.github.skhatri.s3aws.client.S3Client for implementation. 19 | 20 | Pull requests are welcome if you want to modify to your needs. 21 | 22 | Plugin Configuration in your build.gradle 23 | ----------------------------------------- 24 | ``` 25 | buildscript { 26 | dependencies { 27 | classpath 'com.github.skhatri:gradle-s3-plugin:1.0.6' 28 | } 29 | repositories { 30 | mavenCentral() 31 | } 32 | } 33 | apply plugin: 's3' 34 | 35 | s3 { 36 | bucket = 'skhatri-bucket' 37 | awsProfile = 'default' 38 | upload { 39 | //"key" is the name of the target file in S3 (in this example we create a versioned file) 40 | key = java.time.LocalDateTime.now().format(java.time.format.DateTimeFormatter.ofPattern("yyyy/MM/dd")) +'/gradle-s3-plugin-1.0.6.jar' 41 | 42 | // "file" is the name of the local source file 43 | file = '../build/libs/gradle-s3-plugin-1.0.6.jar' 44 | 45 | //"link" will create http redirect to the latest uploaded version of the file 46 | // This will redirect is only available via the "s3 static webpage" option. 47 | // walkthorugh link from AWS on how to set it up 48 | // https://docs.aws.amazon.com/AmazonS3/latest/dev/website-hosting-custom-domain-walkthrough.html 49 | link = 'latest/gradle-plugin.jar' 50 | } 51 | download { 52 | key = 'latest/gradle-plugin.jar' 53 | saveTo = 'gradle-pugin.jar' 54 | } 55 | } 56 | 57 | 58 | ``` 59 | 60 | ### Using Upload Task to upload more artifacts ### 61 | ``` 62 | task uploadAppJar(type: com.github.skhatri.s3aws.plugin.S3UploadTask) { 63 | key = 'gradle-s3-plugin-1.0.0-something.jar' 64 | file = '../build/libs/gradle-s3-plugin-master-1.0.1-SNAPSHOT.jar' 65 | link = 'latest/gradle-plugin.jar' 66 | } 67 | ``` 68 | Then I can call "gradle uploadAppJar" to upload yet another artifact to S3. 69 | 70 | This can be useful, if uploading hash checksums of the artifacts. For instance, I can upload sha1 value of the artifact so my automated artifact deployment task could download checksum file first to decide whether downloading the big artifact is worth it. 71 | 72 | ``` 73 | task writeHash() { 74 | String hashValue = computeHash('../build/libs/gradle-s3-plugin-master-1.0.1-SNAPSHOT.jar') 75 | file('../build/libs/gradle-s3-plugin-master-1.0.1-SNAPSHOT.sha1').write(hashValue) 76 | } 77 | 78 | task uploadHash(type: com.github.skhatri.s3aws.plugin.S3UploadTask) { 79 | key = 'gradle-s3-plugin-1.0.0-something.sha1' 80 | file = '../build/libs/gradle-s3-plugin-master-1.0.1-SNAPSHOT.sha1' 81 | link = 'latest/gradle-plugin.sha1' 82 | } 83 | 84 | task awsUpload(dependsOn:['uploadAppJar', 'writeHash', 'uploadHash']) { 85 | } 86 | ``` 87 | Now, calling awsUpload will upload jar and the hash file. 88 | 89 | ### Downloading more than one artifact ### 90 | 91 | Similarly, I can download more artifacts by simply creating ad-hoc Download task. I am downloading the previously uploaded sha1 file of the artifact using the task below. 92 | 93 | ``` 94 | task awsDownload(type: com.github.skhatri.s3aws.plugin.S3DownloadTask) { 95 | key = 'latest/gradle-plugin.sha1' 96 | saveTo = 'gradle-plugin.txt' 97 | } 98 | ``` 99 | 100 | 101 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original 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 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | --------------------------------------------------------------------------------