Skip to content

Commit 98045d1

Browse files
stefanobaghinostefanobaghino
authored
Fix README structure (#148)
* Fix README structure * Empty commit to trigger CI
1 parent e399b0d commit 98045d1

1 file changed

Lines changed: 43 additions & 40 deletions

File tree

‎README.md‎

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# develocity-actions
22

3-
A collection of composite GitHub Actions related to [Develocity](https://gradle.com/)
3+
A collection of composite GitHub Actions related to [Develocity](https://gradle.com/develocity/):
4+
- [setup-maven](#setup-maven-action)
5+
- [maven-publish-build-scan](#maven-publish-build-scan-action)
6+
- [setup-npm](#setup-npm-action)
47

58
---
69

@@ -9,17 +12,15 @@ A collection of composite GitHub Actions related to [Develocity](https://gradle.
912
### Features
1013

1114
The action enables three features:
12-
- [Build Summary (Maven only)](#build-summary-maven-only): Display a summary of the Maven builds as a GitHub workflow summary or as a pull-request comment
13-
- [Develocity extensions injection (Maven only)](#develocity-extensions-injection-maven-only): Inject Develocity/CCUD Maven extensions
14-
- [Capture Build Scan® data (Maven only)](#capture-build-scan-data-maven-only): Capture published Build Scan® links and unpublished Build Scan® data as a workflow artifact per job with prefix `build-scan-data-maven`, which can then be published in a dependent workflow.
15+
- [Build Summary](#build-summary): Display a summary of the Maven builds as a GitHub workflow summary or as a pull-request comment
16+
- [Develocity extensions injection](#develocity-extensions-injection): Inject Develocity/CCUD Maven extensions
17+
- [Capture Build Scan® data](#capture-build-scan-data): Capture published Build Scan® links and unpublished Build Scan® data as a workflow artifact per job with prefix `build-scan-data-maven`, which can then be published in a dependent workflow.
1518

1619
> [!NOTE]
1720
> This action can be combined with the `maven-publish-build-scan` action to publish Build Scan® in a fork context. See [the relevant section](#maven-publish-build-scan-action) for details.
1821
1922
### Usage
2023

21-
#### Setting up Develocity for Maven
22-
2324
Insert the `Setup Maven` step once in each job having steps invoking Maven. Make sure to put the step before the Maven invocation.
2425

2526
```yaml
@@ -33,27 +34,12 @@ jobs:
3334
[...]
3435
```
3536

36-
#### Setting up Develocity for npm
37-
38-
Insert the `Setup npm` step once in each job having steps invoking npm. Make sure to put the step before the npm invocation.
39-
40-
```yaml
41-
name: PR Build
42-
jobs:
43-
build:
44-
- name: Setup npm
45-
uses: gradle/develocity-actions/setup-npm@v2.0
46-
- name: Build with npm
47-
run: npm run build
48-
[...]
49-
```
50-
5137
> [!NOTE]
5238
> When authenticated access is required to publish a Build Scan®, it is recommended to provide as input `develocity-access-key` to the `setup-maven` and/or `setup-npm` steps. This triggers a request for a [short-lived access token](https://docs.gradle.com/develocity/current/reference/api-manual/#short-lived-access-tokens) instead of relying on the `DEVELOCITY_ACCESS_KEY` environment variable.
5339
5440
---
5541

56-
#### Build Summary (Maven only)
42+
#### Build Summary
5743

5844
###### Requirements
5945
- The Maven project must be compiled with JDK 8 or above
@@ -126,7 +112,7 @@ Additionally, the summary details will be accessible in `$RUNNER_TEMP/build-scan
126112

127113
---
128114

129-
#### Develocity extensions injection (Maven only)
115+
#### Develocity extensions injection
130116

131117
If one wants to inject Develocity Maven Extension (and optionally CCUD Maven Extension), the `develocity-injection-enabled` input should be set to `true`. The `develocity-url`, `develocity-maven-extension-version`, and optionally `develocity-ccud-maven-extension-version` inputs should be set accordingly:
132118
```yaml
@@ -149,7 +135,7 @@ jobs:
149135
150136
---
151137

152-
#### Capture Build Scan® data (Maven only)
138+
#### Capture Build Scan® data
153139

154140
###### Requirements
155141
- The Maven project must be compiled with JDK 8 or above
@@ -186,8 +172,6 @@ The output name is `build-scan-url` and can be used in subsequent steps of the w
186172

187173
### Action inputs
188174

189-
#### Maven action inputs
190-
191175
| Name | Description | Default |
192176
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
193177
| `develocity-access-key` | *Optional*: Develocity access key. Should be set to a secret containing the Develocity Access key | `` |
@@ -212,20 +196,6 @@ The output name is `build-scan-url` and can be used in subsequent steps of the w
212196
| `develocity-custom-develocity-maven-extension-coordinates` | *Optional*: Will not inject the Develocity Maven extension if an extension with provided coordinates is found (value is an artifactId of the extension) | |
213197
| `develocity-custom-ccud-extension-coordinates` | *Optional*: Will not inject the CCUD extension if an extension with provided coordinates is found (value is an artifactId of the extension) | |
214198

215-
#### npm action inputs
216-
217-
| Name | Description | Default |
218-
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
219-
| `develocity-access-key` | *Optional*: Develocity access key. Should be set to a secret containing the Develocity Access key | `` |
220-
| `develocity-token-expiry` | *Optional*: Develocity short-lived access tokens expiry in hours | `2` |
221-
| `develocity-injection-enabled` | *Optional*: Whether to enable or not Develocity npm agent injection | |
222-
| `develocity-url` | *Optional*: Develocity server URL | |
223-
| `develocity-npm-agent-version` | *Optional*: Develocity npm agent version to be injected (ignored when `develocity-npm-agent-url-override` is set) | `latest` |
224-
| `develocity-npm-agent-install-location` | *Optional*: Develocity npm agent installation location | `~/.node_libraries` |
225-
| `develocity-pacote-version` | *Optional*: Version of pacote to use to install the Develocity npm build agent | `21.0.0` |
226-
| `develocity-allow-untrusted-server` | *Optional*: Whether to allow communicating with untrusted server | |
227-
| `develocity-npm-agent-url-override` | *Optional*: Override the URL to use to download the Develocity NPM agent | |
228-
229199
---
230200

231201
## maven-publish-build-scan action
@@ -337,3 +307,36 @@ git push origin vX.Y
337307
```
338308

339309
- Empty the release notes in `release/changelog.md` and push the change to prepare for next development iteration
310+
311+
---
312+
313+
## setup-npm action
314+
315+
### Usage
316+
317+
Insert the `Setup npm` step once in each job having steps invoking npm. Make sure to put the step before the npm invocation.
318+
319+
```yaml
320+
name: PR Build
321+
jobs:
322+
build:
323+
- name: Setup npm
324+
uses: gradle/develocity-actions/setup-npm@v2.0
325+
- name: Build with npm
326+
run: npm run build
327+
[...]
328+
```
329+
330+
### Action inputs
331+
332+
| Name | Description | Default |
333+
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
334+
| `develocity-access-key` | *Optional*: Develocity access key. Should be set to a secret containing the Develocity Access key | `` |
335+
| `develocity-token-expiry` | *Optional*: Develocity short-lived access tokens expiry in hours | `2` |
336+
| `develocity-injection-enabled` | *Optional*: Whether to enable or not Develocity npm agent injection | |
337+
| `develocity-url` | *Optional*: Develocity server URL | |
338+
| `develocity-npm-agent-version` | *Optional*: Develocity npm agent version to be injected (ignored when `develocity-npm-agent-url-override` is set) | `latest` |
339+
| `develocity-npm-agent-install-location` | *Optional*: Develocity npm agent installation location | `~/.node_libraries` |
340+
| `develocity-pacote-version` | *Optional*: Version of pacote to use to install the Develocity npm build agent | `21.0.0` |
341+
| `develocity-allow-untrusted-server` | *Optional*: Whether to allow communicating with untrusted server | |
342+
| `develocity-npm-agent-url-override` | *Optional*: Override the URL to use to download the Develocity NPM agent | |

0 commit comments

Comments
 (0)