From 3836e946f437ac448911b08f9e9dcae65e29ea6a Mon Sep 17 00:00:00 2001 From: Oliver Spryn <2717340+oliverspryn@users.noreply.github.com> Date: Wed, 2 Oct 2019 12:16:39 -0400 Subject: [PATCH] Fixes #7 Change Plugin Version --- {docs => .docs}/artwork/banner.png | Bin {docs => .docs}/artwork/gradle.png | Bin {docs => .docs}/artwork/slack.png | Bin {docs => .docs}/artwork/thumbs-up.png | Bin {docs => .docs}/logos/myupmc.png | Bin {docs => .docs}/logos/upmc-enterprises.jpg | Bin .../screenshots/add-bot-functionality.png | Bin .../screenshots/bot-access-token.png | Bin .../screenshots/bot-user-details.png | Bin .../completed-features-and-functionality.png | Bin {docs => .docs}/screenshots/create-app.png | Bin .../screenshots/display-information.png | Bin {docs => .docs}/screenshots/slack-message.png | Bin README.md | 36 +++++++++--------- build.gradle | 36 +++++++++--------- demo/build.gradle | 8 ++-- gradle/wrapper/gradle-wrapper.properties | 6 +-- settings.gradle | 2 +- 18 files changed, 44 insertions(+), 44 deletions(-) rename {docs => .docs}/artwork/banner.png (100%) rename {docs => .docs}/artwork/gradle.png (100%) rename {docs => .docs}/artwork/slack.png (100%) rename {docs => .docs}/artwork/thumbs-up.png (100%) rename {docs => .docs}/logos/myupmc.png (100%) rename {docs => .docs}/logos/upmc-enterprises.jpg (100%) rename {docs => .docs}/screenshots/add-bot-functionality.png (100%) rename {docs => .docs}/screenshots/bot-access-token.png (100%) rename {docs => .docs}/screenshots/bot-user-details.png (100%) rename {docs => .docs}/screenshots/completed-features-and-functionality.png (100%) rename {docs => .docs}/screenshots/create-app.png (100%) rename {docs => .docs}/screenshots/display-information.png (100%) rename {docs => .docs}/screenshots/slack-message.png (100%) diff --git a/docs/artwork/banner.png b/.docs/artwork/banner.png similarity index 100% rename from docs/artwork/banner.png rename to .docs/artwork/banner.png diff --git a/docs/artwork/gradle.png b/.docs/artwork/gradle.png similarity index 100% rename from docs/artwork/gradle.png rename to .docs/artwork/gradle.png diff --git a/docs/artwork/slack.png b/.docs/artwork/slack.png similarity index 100% rename from docs/artwork/slack.png rename to .docs/artwork/slack.png diff --git a/docs/artwork/thumbs-up.png b/.docs/artwork/thumbs-up.png similarity index 100% rename from docs/artwork/thumbs-up.png rename to .docs/artwork/thumbs-up.png diff --git a/docs/logos/myupmc.png b/.docs/logos/myupmc.png similarity index 100% rename from docs/logos/myupmc.png rename to .docs/logos/myupmc.png diff --git a/docs/logos/upmc-enterprises.jpg b/.docs/logos/upmc-enterprises.jpg similarity index 100% rename from docs/logos/upmc-enterprises.jpg rename to .docs/logos/upmc-enterprises.jpg diff --git a/docs/screenshots/add-bot-functionality.png b/.docs/screenshots/add-bot-functionality.png similarity index 100% rename from docs/screenshots/add-bot-functionality.png rename to .docs/screenshots/add-bot-functionality.png diff --git a/docs/screenshots/bot-access-token.png b/.docs/screenshots/bot-access-token.png similarity index 100% rename from docs/screenshots/bot-access-token.png rename to .docs/screenshots/bot-access-token.png diff --git a/docs/screenshots/bot-user-details.png b/.docs/screenshots/bot-user-details.png similarity index 100% rename from docs/screenshots/bot-user-details.png rename to .docs/screenshots/bot-user-details.png diff --git a/docs/screenshots/completed-features-and-functionality.png b/.docs/screenshots/completed-features-and-functionality.png similarity index 100% rename from docs/screenshots/completed-features-and-functionality.png rename to .docs/screenshots/completed-features-and-functionality.png diff --git a/docs/screenshots/create-app.png b/.docs/screenshots/create-app.png similarity index 100% rename from docs/screenshots/create-app.png rename to .docs/screenshots/create-app.png diff --git a/docs/screenshots/display-information.png b/.docs/screenshots/display-information.png similarity index 100% rename from docs/screenshots/display-information.png rename to .docs/screenshots/display-information.png diff --git a/docs/screenshots/slack-message.png b/.docs/screenshots/slack-message.png similarity index 100% rename from docs/screenshots/slack-message.png rename to .docs/screenshots/slack-message.png diff --git a/README.md b/README.md index d97d88f..c3b653e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +

@@ -14,10 +14,10 @@ "Works to help you improve your CI and CD practices." ``` -[![Supported Kotlin Versions](https://img.shields.io/badge/Kotlin-1.3.21%2B-green.svg?logo=kotlin&style=flat&logoColor=green)](https://kotlinlang.org/) -[![Supported Gradle Versions](https://img.shields.io/badge/Gradle-4.10%2B-green.svg?logo=java&style=flat&logoColor=green)](https://gradle.org/) +[![Supported Kotlin Versions](https://img.shields.io/badge/Kotlin-1.3.50%2B-green.svg?logo=kotlin&style=flat&logoColor=green)](https://kotlinlang.org/) +[![Supported Gradle Versions](https://img.shields.io/badge/Gradle-5.6.2%2B-green.svg?logo=java&style=flat&logoColor=green)](https://gradle.org/) [![Latest Release](https://img.shields.io/github/release/upmc-enterprises/gradle-slack-uploader-plugin.svg?label=Release)](https://github.com/upmc-enterprises/gradle-slack-uploader-plugin/releases) -![Available on the Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/com/oliverspryn/gradleslackuploaderplugin/com.oliverspryn.gradleslackuploaderplugin.gradle.plugin/maven-metadata.xml.svg?label=Gradle%20Plugin%20Portal) +![Available on the Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/com/oliverspryn/gradle/slackuploader/com.oliverspryn.gradle.slackuploader.gradle.plugin/maven-metadata.xml.svg?label=Gradle%20Plugin%20Portal) [![Available on JitPack](https://jitpack.io/v/upmc-enterprises/gradle-slack-uploader.svg)](https://jitpack.io/#upmc-enterprises/gradle-slack-uploader)
@@ -35,7 +35,7 @@ Whenever a file is uploaded, you can expect it to feel very familiar and flexibl
-![Slack message from the Gradle plugin with an APK file](docs/screenshots/slack-message.png) +![Slack message from the Gradle plugin with an APK file](.docs/screenshots/slack-message.png)
@@ -51,31 +51,31 @@ Unless your Slack administrator has banned unapproved apps from being installed 1. Press the *Create New App* button. Apps within Slack enable automated bots to post messages to a Slack channel. 1. In the pop-up dialog, give the app a friendly name. This name is for your reference only and is not reflected as the bot's name in a Slack workspace whenever it posts a message. You will configure the bot's name later. - Slack application creation dialog + Slack application creation dialog 1. After creating the app, click on the *Bots* button, under the *Add Features and Functionality* section - Add bot functionality + Add bot functionality 1. Click the *Add a Bot User* button and fill out the form. The Display Name is effectively the bot's First and Last Name, which appears as the sender of a Slack message. You can populate this form as you please. Here is an example set up: - Bot user details + Bot user details 1. Save your changes and the go back to the *Basic Information* page, which is available from the left-column navigation 1. Under the *Add Features and Functionality* section, both the *Bots* and *Permissions* features should show as completed - Completed Features and Functionality + Completed Features and Functionality 1. **(Optional)** Populate the *Display Information*. This can be thought of as the bot's profile picture and status message. - Completed Features and Functionality + Completed Features and Functionality 1. Click on *Install Your App to Your Workspace* and follow Slack's installation and permission prompts 1. After installing the app, go back to the app's configuration 1. On the left-column navigation go to *OAuth & Permissions* 1. Make a note of the *Bot User OAuth Access Token* (not the OAuth Access Token). You will need this for a subsequent step. **Keep this token safe, as having access to it enables anyone to send messages to your workspace.** - Bot User OAuth Access Token + Bot User OAuth Access Token ## Install the Plugin into Gradle @@ -90,7 +90,7 @@ Newer version of Gradle support the updated [plugin DSL](https://docs.gradle.org ```groovy plugins { - id "com.oliverspryn.gradleslackuploaderplugin" version "" + id "com.oliverspryn.gradle.slackuploader" version "" } ``` @@ -108,7 +108,7 @@ Older versions of Gradle do not support the modern [plugin DSL](https://docs.gra } dependencies { - classpath "gradle.plugin.com.oliverspryn.gradle:gradle-slack-uploader-plugin:" + classpath "gradle.plugin.com.oliverspryn.gradle:slack-uploader:" } } ``` @@ -116,7 +116,7 @@ Older versions of Gradle do not support the modern [plugin DSL](https://docs.gra 1. Now, apply it: ```groovy - apply plugin: 'com.oliverspryn.gradleslackuploaderplugin' + apply plugin: "com.oliverspryn.gradle.slackuploader" ``` ### Using JitPack (Not Recommended) @@ -141,7 +141,7 @@ For the sake of convinence, this plugin is also available on JitPack. These step 1. Now, apply it: ```groovy - apply plugin: "com.oliverspryn.gradleslackuploaderplugin" + apply plugin: "com.oliverspryn.gradle.slackuploader" ``` # Configuring the Plugin @@ -238,7 +238,7 @@ Here are answers to a few questions you may encounter when setting up or using t ```groovy static def isCIMachine() { - return System.getenv('CI') != null + return System.getenv("CI") != null } uploadFileToSlack { @@ -256,10 +256,10 @@ Here are answers to a few questions you may encounter when setting up or using t

This plugin was inspired by a need for the MyUPMC project at UPMC Enterprises

- MyUPMC + MyUPMC - UPMC Enterprises + UPMC Enterprises
diff --git a/build.gradle b/build.gradle index 5bfebdb..95ca49c 100644 --- a/build.gradle +++ b/build.gradle @@ -1,18 +1,18 @@ plugins { - id 'com.gradle.plugin-publish' version '0.10.1' - id 'java-gradle-plugin' - id 'maven' - id 'org.jetbrains.kotlin.jvm' version '1.3.21' + id "com.gradle.plugin-publish" version "0.10.1" + id "java-gradle-plugin" + id "maven" + id "org.jetbrains.kotlin.jvm" version "1.3.50" } -group 'com.oliverspryn.gradle' -version '1.0.1' +group "com.oliverspryn.gradle" +version "2.0.0" gradlePlugin { plugins { - gradleSlackUploaderPlugin { - id = 'com.oliverspryn.gradleslackuploaderplugin' - implementationClass = 'com.oliverspryn.gradle.SlackUploaderPlugin' + slackUploader { + id = "com.oliverspryn.gradle.slackuploader" + implementationClass = "com.oliverspryn.gradle.SlackUploaderPlugin" } } } @@ -29,29 +29,29 @@ dependencies { implementation gradleApi() // Kotlin - implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.21' + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.50" // jSlack - implementation 'com.github.seratch:jslack:1.3.0' + implementation "com.github.seratch:jslack:2.2.3" } uploadArchives { repositories { mavenDeployer { - repository(url: uri('./repo')) + repository(url: uri("./repo")) } } } pluginBundle { - description = 'Uploads artifacts from a Gradle build as a file to a Slack channel' - website = 'https://oliverspryn.com/' - vcsUrl = 'https://github.com/upmc-enterprises/gradle-slack-uploader-plugin' - tags = ['artifacts', 'build', 'build artifacts', 'cd', 'ci', 'files', 'kotlin', 'slack'] + description = "Uploads artifacts from a Gradle build as a file to a Slack channel" + website = "https://oliverspryn.com/" + vcsUrl = "https://github.com/upmc-enterprises/gradle-slack-uploader-plugin" + tags = ["artifacts", "build", "build artifacts", "cd", "ci", "files", "kotlin", "slack"] plugins { - gradleSlackUploaderPlugin { - displayName = 'Gradle Greeting plugin' + slackUploader { + displayName = "Gradle Greeting plugin" } } } diff --git a/demo/build.gradle b/demo/build.gradle index 8b09c9c..157eab6 100644 --- a/demo/build.gradle +++ b/demo/build.gradle @@ -1,20 +1,20 @@ buildscript { repositories { maven { - url uri('../repo') + url uri("../repo") } } dependencies { - classpath "com.oliverspryn.gradle:gradle-slack-uploader-plugin:1.0.0" + classpath "com.oliverspryn.gradle:slack-uploader:2.0.0" } } plugins { - id 'org.jetbrains.kotlin.jvm' version '1.3.21' + id "org.jetbrains.kotlin.jvm" version "1.3.50" } -apply plugin: "com.oliverspryn.gradleslackuploaderplugin" +apply plugin: "com.oliverspryn.gradle.slackuploader" repositories { jcenter() diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index a0b9d5d..94d4549 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Tue Mar 26 16:36:32 EDT 2019 +#Wed Oct 02 11:24:56 EDT 2019 +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-4.10-all.zip +zipStoreBase=GRADLE_USER_HOME diff --git a/settings.gradle b/settings.gradle index d9e3026..b9336d4 100644 --- a/settings.gradle +++ b/settings.gradle @@ -8,4 +8,4 @@ pluginManagement { } } -rootProject.name = 'gradle-slack-uploader-plugin' +rootProject.name = 'slack-uploader'