Skip to content

Commit edf85f5

Browse files
committed
docs: update docs to account for new gradle-bloop home
1 parent 429e626 commit edf85f5

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

docs-gen/src/main/scala/bloop/Docs.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ object Docs {
1616
Map(
1717
"VERSION" -> Sonatype.releaseBloop.version,
1818
"LATEST_VERSION" -> bloop.internal.build.BuildInfo.version,
19-
"BLOOP_MAVEN_VERSION" -> Sonatype.releaseBloopMaven.version
19+
"BLOOP_MAVEN_VERSION" -> Sonatype.releaseBloopMaven.version,
20+
"BLOOP_GRADLE_VERSION" -> Sonatype.releaseBloopGradle.version
2021
)
2122
)
2223
.withArgs(args.toList)

docs-gen/src/main/scala/bloop/docs/Sonatype.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ object Sonatype {
2424
lazy val releaseBloop = fetchLatest("bloop-frontend_2.12")
2525
lazy val releaseBloopMaven = fetchLatest("bloop-maven-plugin")
2626
lazy val releaseLauncher = fetchLatest("bloop-launcher_2.12")
27+
lazy val releaseBloopGradle = fetchLatest("gradle-bloop_2.13")
2728

2829
/** Returns the latest published snapshot release, or the current release if. */
2930
private def fetchLatest(artifact: String): Release = {

docs/build-tools/gradle.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Configuring bloop in your Gradle projects will speed up your Scala
1010
development significantly. It is highly recommended to use Bloop in Gradle
1111
because Gradle has a pretty long development cycle and it takes a long time
1212
to do basic build operations such as compilation or running an application.
13+
14+
The Gradle plugin lives in its own repository at
15+
[scalacenter/gradle-bloop](https://github.com/scalacenter/gradle-bloop). Please
16+
do report any issues with the Gradle integration there!
17+
1318
Learn how to get set up by following the instructions below.
1419

1520
<!-- start -->
@@ -29,8 +34,6 @@ Here is a list of the latest Bloop stable and development versions.
2934
I am going to be replaced by the docs infrastructure.
3035
```
3136

32-
33-
3437
Add bloop to your `build.gradle` with:
3538

3639
```gradle
@@ -41,12 +44,11 @@ buildscript {
4144
}
4245
4346
dependencies {
44-
classpath 'ch.epfl.scala:gradle-bloop_2.12:@VERSION@'
47+
classpath 'ch.epfl.scala:gradle-bloop_2.12:@BLOOP_GRADLE_VERSION@'
4548
}
4649
}
4750
```
4851

49-
5052
Then, enable bloop in all your Gradle projects with:
5153

5254
```gradle

docs/contributing-guide.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,17 @@ If you're looking for the Maven integration, then you'll want to make those
2828
changes in
2929
[scalacenter/bloop-maven-plugin](https://github.com/scalacenter/bloop-maven-plugin).
3030

31+
If you're looking to the Gradle integration, then you'll want to make those
32+
changes in
33+
[scalacenter/gradle-bloop](https://github.com/scalacenter/gradle-bloop).
34+
3135
## Project structure
3236

3337
Here's a list of the most important directories in the bloop repositories.
3438

3539
1. `backend` defines low-level compiler APIs wrapping Zinc APIs.
3640
1. `frontend` defines the core of bloop, the task scheduling, the CLI and all the supported tasks: compilation, testing, running and linking.
37-
1. `integrations` contains plugins for some of the supported build tools, sbt
38-
and Gradle, to extract any build to bloop.
41+
1. `integrations` contains the sbt plugin to extract any sbt build to bloop.
3942

4043
When contributing to bloop, you will most likely need to modify code in the
4144
above directories. The next directories define the rest of the project and

0 commit comments

Comments
 (0)