Skip to content

Commit

Permalink
Fixes #7 Change Plugin Version
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverspryn authored Oct 2, 2019
1 parent 5ee3235 commit 3836e94
Show file tree
Hide file tree
Showing 18 changed files with 44 additions and 44 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img src="docs/artwork/banner.png" />
<img src=".docs/artwork/banner.png" />

<br>
<br>
Expand All @@ -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)

<hr />
Expand All @@ -35,7 +35,7 @@ Whenever a file is uploaded, you can expect it to feel very familiar and flexibl

<div align="center">

![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)

</div>

Expand All @@ -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.

<img alt="Slack application creation dialog" src="docs/screenshots/create-app.png" width="320" />
<img alt="Slack application creation dialog" src=".docs/screenshots/create-app.png" width="320" />

1. After creating the app, click on the *Bots* button, under the *Add Features and Functionality* section

<img alt="Add bot functionality" src="docs/screenshots/add-bot-functionality.png" width="320" />
<img alt="Add bot functionality" src=".docs/screenshots/add-bot-functionality.png" width="320" />

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:

<img alt="Bot user details" src="docs/screenshots/bot-user-details.png" width="320" />
<img alt="Bot user details" src=".docs/screenshots/bot-user-details.png" width="320" />

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

<img alt="Completed Features and Functionality" src="docs/screenshots/completed-features-and-functionality.png" width="320" />
<img alt="Completed Features and Functionality" src=".docs/screenshots/completed-features-and-functionality.png" width="320" />

1. **(Optional)** Populate the *Display Information*. This can be thought of as the bot's profile picture and status message.

<img alt="Completed Features and Functionality" src="docs/screenshots/display-information.png" width="320" />
<img alt="Completed Features and Functionality" src=".docs/screenshots/display-information.png" width="320" />

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.**

<img alt="Bot User OAuth Access Token" src="docs/screenshots/bot-access-token.png" width="320" />
<img alt="Bot User OAuth Access Token" src=".docs/screenshots/bot-access-token.png" width="320" />

## Install the Plugin into Gradle

Expand All @@ -90,7 +90,7 @@ Newer version of Gradle support the updated [plugin DSL](https://docs.gradle.org

```groovy
plugins {
id "com.oliverspryn.gradleslackuploaderplugin" version "<latest version>"
id "com.oliverspryn.gradle.slackuploader" version "<latest version>"
}
```
Expand All @@ -108,15 +108,15 @@ 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:<latest version>"
classpath "gradle.plugin.com.oliverspryn.gradle:slack-uploader:<latest-version>"
}
}
```
1. Now, apply it:
```groovy
apply plugin: 'com.oliverspryn.gradleslackuploaderplugin'
apply plugin: "com.oliverspryn.gradle.slackuploader"
```
### Using JitPack (Not Recommended)
Expand All @@ -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
Expand Down Expand Up @@ -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 {
Expand All @@ -256,10 +256,10 @@ Here are answers to a few questions you may encounter when setting up or using t
<p>This plugin was inspired by a need for the <a href="https://myupmc.upmc.com" target="_blank">MyUPMC</a> project at <a href="https://enterprises.upmc.com" target="_blank">UPMC Enterprises</a></p>

<a href="https://myupmc.upmc.com" target="_blank">
<img alt="MyUPMC" src="docs/logos/myupmc.png" height="40" />
<img alt="MyUPMC" src=".docs/logos/myupmc.png" height="40" />
</a>

<a href="https://enterprises.upmc.com" target="_blank">
<img alt="UPMC Enterprises" src="docs/logos/upmc-enterprises.jpg" height="40" />
<img alt="UPMC Enterprises" src=".docs/logos/upmc-enterprises.jpg" height="40" />
</a>
</div>
36 changes: 18 additions & 18 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
Expand All @@ -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"
}
}
}
8 changes: 4 additions & 4 deletions demo/build.gradle
Original file line number Diff line number Diff line change
@@ -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()
Expand Down
6 changes: 3 additions & 3 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ pluginManagement {
}
}

rootProject.name = 'gradle-slack-uploader-plugin'
rootProject.name = 'slack-uploader'

0 comments on commit 3836e94

Please sign in to comment.