Prepare for release

Author: JakeWharton

.github/workflows/build.yaml

@@ -1,14 +1,19 @@
 name: build
 
-on: [push, pull_request]
+on:
+  pull_request: {}
+  push:
+    branches:
+      - '*'
+    tags:
+      - '*'
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-
       - uses: actions/setup-java@v1
         with:
           java-version: 11
@@ -21,3 +26,17 @@ jobs:
           name: dependency-tree-diff.jar
           path: build/dependency-tree-diff.jar
           if-no-files-found: error
+
+      - name: Extract release notes
+        id: release_notes
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: ffurrer2/extract-release-notes@v1
+
+      - name: Create Release
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v1
+        with:
+          body: ${{ steps.release_notes.outputs.release_notes }}
+          files: build/dependency-tree-diff.jar
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+## [Unreleased]
+
+## [1.0.0] - 2020-08-24
+
+Initial release
+
+
+[Unreleased]: https://github.com/JakeWharton/dependency-watch/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/JakeWharton/dependency-watch/releases/tag/1.0.0

README.md

@@ -90,6 +90,21 @@ $ ./dependency-tree-diff.jar old.txt new.txt
 
 See `src/test/fixtures/` for example outputs and their expected diffs.
 
+## Install
+
+**Mac OS**
+
+```
+$ brew install JakeWharton/repo/dependency-tree-diff
+```
+
+**Other**
+
+Download standalone JAR from
+[latest release](https://github.com/JakeWharton/dependency-tree-diff/releases/latest).
+On MacOS and Linux you can `chmod +x` and execute the `.jar` directly.
+On Windows use `java -jar`.
+
 
 ## License
 

RELEASING.md

@@ -0,0 +1,29 @@
+# Releasing
+
+1. Update the `CHANGELOG.md`:
+   1. Change the `Unreleased` header to the release version.
+   2. Add a link URL to ensure the header link works.
+   3. Add a new `Unreleased` section to the top.
+
+2. Commit
+
+   ```
+   $ git commit -am "Prepare version X.Y.X"
+   ```
+
+3. Tag
+
+   ```
+   $ git tag -am "Version X.Y.Z" X.Y.Z
+   ```
+
+4. Push!
+
+   ```
+   $ git push && git push --tags
+   ```
+
+   This will trigger a GitHub Action workflow which will create a GitHub release, upload the
+   jar, and send a PR to the Homebrew repo.
+
+5. Find [the Homebrew PR](https://github.com/JakeWharton/homebrew-repo/pulls) and merge it!

build.gradle

@@ -24,7 +24,7 @@ def fatJarProvider = tasks.register('fatJar', Jar) { task ->
 	task.classifier 'fat'
 
 	task.manifest {
-		attributes 'Main-Class': 'com.jakewharton.gradle.dependencies.diff.Main'
+		attributes 'Main-Class': 'com.jakewharton.gradle.dependencies.DependencyTreeDiff'
 	}
 
 	def sourceClasses = sourceSets.main.output.classesDirs

src/main/kotlin/com/jakewharton/gradle/dependencies/diff/nio.kt

@@ -0,0 +1,28 @@
+@file:JvmName("DependencyTreeDiff")
+
+package com.jakewharton.gradle.dependencies
+
+import java.nio.charset.Charset
+import java.nio.charset.StandardCharsets
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+import kotlin.system.exitProcess
+
+fun main(vararg args: String) {
+	if (args.size != 2) {
+		System.err.println("Usage: dependency-tree-diff old.txt new.txt")
+		exitProcess(1)
+	}
+
+	val old = args[0].let(Paths::get).readText()
+	val new = args[1].let(Paths::get).readText()
+
+	print(dependencyTreeDiff(old, new))
+}
+
+// TODO replace with https://youtrack.jetbrains.com/issue/KT-19192
+@Suppress("NOTHING_TO_INLINE")
+private inline fun Path.readText(charset: Charset = StandardCharsets.UTF_8): String {
+	return Files.readAllBytes(this).toString(charset)
+}

src/main/kotlin/com/jakewharton/gradle/dependencies/main.kt

@@ -1,22 +1,8 @@
-@file:JvmName("Main")
+@file:JvmName("DependencyTrees")
 
-package com.jakewharton.gradle.dependencies.diff
+package com.jakewharton.gradle.dependencies
 
-import java.nio.file.Paths
 import java.util.ArrayDeque
-import kotlin.system.exitProcess
-
-fun main(vararg args: String) {
-	if (args.size != 2) {
-		System.err.println("Usage: dependency-tree-diff old.txt new.txt")
-		exitProcess(1)
-	}
-
-	val old = args[0].let(Paths::get).readText()
-	val new = args[1].let(Paths::get).readText()
-
-	print(dependencyTreeDiff(old, new))
-}
 
 fun dependencyTreeDiff(old: String, new: String): String {
 	val oldPaths = findDependencyPaths(old)
@@ -76,12 +62,6 @@ private fun buildTree(paths: Iterable<List<String>>): List<Node> {
 	return rootNodes
 }
 
-private fun diffTrees(oldTree: List<Node>, newTree: List<Node>): String {
-	return buildString {
-		appendDiff(oldTree, newTree, "")
-	}
-}
-
 private fun StringBuilder.appendDiff(
 	oldTree: List<Node>,
 	newTree: List<Node>,

src/main/kotlin/com/jakewharton/gradle/dependencies/diff/main.kt renamed to src/main/kotlin/com/jakewharton/gradle/dependencies/treeDiff.kt

@@ -2,6 +2,6 @@
 -allowaccessmodification
 -keepattributes SourceFile, LineNumberTable
 
--keep class com.jakewharton.gradle.dependencies.diff.Main {
+-keep class com.jakewharton.gradle.dependencies.DependencyTreeDiff {
 	public static void main(java.lang.String[]);
 }

src/main/rules.txt

@@ -1,4 +1,4 @@
-package com.jakewharton.gradle.dependencies.diff
+package com.jakewharton.gradle.dependencies
 
 import com.google.common.truth.Truth.assertThat
 import org.junit.Test