Skip to content

README: give shorter install instruction with http_jar #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 4, 2021
Merged

README: give shorter install instruction with http_jar #31

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffca3ab
README: give shorter install instruction with http_jar
Dec 14, 2020
c336083
Merge branch 'master' into master
tinder-maxwellelliott Jan 4, 2021
9f2f1a2
Merge branch 'master' into master
tinder-maxwellelliott Jan 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 49 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Track the feature request for target diffing in Bazel [here](https://github.com/

This approach was inspired by the [following BazelConf talk](https://www.youtube.com/watch?v=9Dk7mtIm7_A) by Benjamin Peterson.

> There are simpler and faster ways to approximate the affected set of targets.
> However an incorrect solution can result in a system you can't trust,
> because tests could be broken at a commit where you didn't select to run them.
> Then you can't rely on green-to-red (or red-to-green) transitions and
> lose much of the value from your CI system as breakages can be discovered
> later on unrelated commits.

## Prerequisites

* Git
Expand Down Expand Up @@ -156,16 +163,43 @@ workspace.

## Installing

### Run from Source
### Integrate into your project (recommended)

After cloning down the repo, you are good to go, Bazel will handle the rest
Add to your `WORKSPACE` file:

To run the project
```bazel
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")

http_jar(
name = "bazel_diff",
urls = [
"https://github.com/Tinder/bazel-diff/releases/download/2.0.0/bazel-diff_deploy.jar",
],
sha256 = "c16296d2c770365a410253c8f6dc88061f412ca94cc1cbe4328705e4eed50378",
)
```

and then in your root `BUILD.bazel` file:

```bazel
load("@rules_java//java:defs.bzl", "java_binary")

java_binary(
name = "bazel-diff",
main_class = "com.bazel_diff.BazelDiff",
runtime_deps = ["@bazel_diff//jar"],
)
```

now run the tool with

```terminal
bazel run :bazel-diff -- bazel-diff -h
bazel run //:bazel-diff
```


> Note, in releases prior to 2.0.0 the value for the `main_class` attribute is just `BazelDiff`

#### Debugging

To run `bazel-diff` with debug logging, run your commands with the `verbose` config like so:
Expand All @@ -181,14 +215,24 @@ curl -LO bazel-diff.jar GITHUB_RELEASE_JAR_URL
java -jar bazel-diff.jar -h
```

### Build from Source

After cloning down the repo, you are good to go, Bazel will handle the rest

To run the project

```terminal
bazel run :bazel-diff -- bazel-diff -h
```

### Build your own deployable JAR

```terminal
bazel build //src/main/java/com/bazel_diff:bazel-diff_deploy.jar
java -jar bazel-bin/src/main/java/com/bazel_diff/bazel-diff_deploy.jar # This JAR can be run anywhere
```

### Integrate directly into your Bazel Project
### Build from sources in your Bazel Project

Add the following to your `WORKSPACE` file to add the external repositories, replacing the `RELEASE_ARCHIVE_URL` with the archive url of the bazel-diff release you wish to depend on:

Expand Down