|
2 | 2 |
|
3 | 3 | A library for fetching, processing, and analyzing Develocity build data with a fluent API, built-in caching, and retry mechanisms. |
4 | 4 |
|
5 | | -The library aims to simplify interactions with the `/api/builds/**` endpoints of the Develocity API by providing a high level API with proper typed classes for each build tool. |
6 | | -When using this library, you'll focus less on how to interact with the Develocity API and more on the processing and analysis of build data. |
7 | | - |
8 | | -Learn more about how to get started and leverage the full potential of Develocity and your build data below. |
| 5 | +The library aims to simplify working with the `/api/builds/**` endpoints from the Develocity API by providing a high level API with built-in convenience methods covering common use cases and proper typed classes for each build tool. |
| 6 | +When using this library, you'll focus more on the actual processing and analysis of build data and less on the underlying Develocity API. |
9 | 7 |
|
10 | 8 | ## Getting started |
11 | 9 |
|
@@ -55,8 +53,8 @@ A `BuildProcessor` works much like a Java `Stream` in that it has both *intermed |
55 | 53 |
|
56 | 54 | #### Intermediate operations |
57 | 55 |
|
58 | | -A `BuildProcessor` has several _intermediate operations_ used for the actual processing of data. |
59 | | -There are several operators for use depending on your use case. |
| 56 | +A `BuildProcessor` has several _intermediate operations_ used for processing build data. |
| 57 | +There are several operators available to use depending on your use case. |
60 | 58 |
|
61 | 59 | ```java |
62 | 60 | // Print the ID of any build |
@@ -91,9 +89,9 @@ processor.process(LocalDateTime.parse("2024-10-05T10:15:30"), "buildTool:gradle" |
91 | 89 |
|
92 | 90 | #### Build models |
93 | 91 |
|
94 | | -By default, the Develocity API returns a very limited amount of data about each build. |
95 | | -To get more details, you need to define the *build models* to be returned. |
96 | | -The more build models that are requested, the longer the query will take. |
| 92 | +By default, the Develocity API returns very limited data about each build. |
| 93 | +To get more details, you need to declare the *build models* you require. |
| 94 | +The more build models that are required, the longer the query will take. |
97 | 95 |
|
98 | 96 | This library works similarly. |
99 | 97 | To use the additional data from the requested build models, cast the returned `Build` into a `BazelBuild`, `GradleBuild`, `MavenBuild`, or `SbtBuild`. |
@@ -121,7 +119,7 @@ processor.onGradleBuild(gradleBuild -> { |
121 | 119 | }); |
122 | 120 | ``` |
123 | 121 |
|
124 | | -Given requesting the *attributes* build models is so common, typically because this is the build model containing the custom values and tags, it's possible to query for these directly through the top-level `Build` object without casting. |
| 122 | +Given requesting the *attributes* build models is so common, it's possible to query for custom values, tags, and several other attributes shared between each build tool directly through the top-level `Build` object without casting. |
125 | 123 |
|
126 | 124 | ```java |
127 | 125 | processor.withRequiredBuildModels(GRADLE_ATTRIBUTES, MAVEN_ATTRIBUTES); |
|
0 commit comments