Skip to content

Commit 963df39

Browse files
authored
Rename vars in docs to DEVELOCITY_ (#190)
Leftover from #188. Part of #184.
1 parent 53e95df commit 963df39

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ api.buildsApi.getBuildsFlow(fromInstant = 0, query = "buildStartTime<-1d").forEa
2222

2323
Set up environment variables and use the library from any notebook, script or project:
2424

25-
- [`GRADLE_ENTERPRISE_API_URL`][16]: the URL of your Develocity instance
26-
- [`GRADLE_ENTERPRISE_API_TOKEN`][17]: an [access key][31] for the Develocity instance
27-
- [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12] (optional, off by default): enables caching for some
25+
- [`DEVELOCITY_API_URL`][16]: the URL of your Develocity instance
26+
- [`DEVELOCITY_API_TOKEN`][17]: an [access key][31] for the Develocity instance
27+
- [`DEVELOCITY_API_CACHE_ENABLED`][12] (optional, off by default): enables caching for some
2828
requests (see [caveats][13])
2929

3030
### Setup snippets
@@ -100,7 +100,7 @@ runBlocking {
100100
### Caching
101101

102102
HTTP caching is available, which can speed up queries significantly, but is
103-
off by default. Enable by simply setting [`GRADLE_ENTERPRISE_API_CACHE_ENABLED`][12] to `true`. See
103+
off by default. Enable by simply setting [`DEVELOCITY_API_CACHE_ENABLED`][12] to `true`. See
104104
[`CacheConfig`][13] for caveats.
105105

106106
### Extensions

docs/AccessKeys.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Access key / API token
22

3-
[All API requests require authentication][1]. Provide a valid access key of your Gradle Enterprise instance as the `GRADLE_ENTERPRISE_API_TOKEN` environment variable.
3+
[All API requests require authentication][1]. Provide a valid access key of your Gradle Enterprise instance as the `DEVELOCITY_API_TOKEN` environment variable.
44

55
## How to get an access key
66

77
1. Sign in to Gradle Enterprise (with a user that has “Export build data” permission)
88
2. Go to "My settings" from the user menu in the top right-hand corner of the page
99
3. Go to "Access keys" from the sidebar
1010
4. Click "Generate" on the right-hand side
11-
5. Set key as the `GRADLE_ENTERPRISE_API_TOKEN` environment variable when using the library
11+
5. Set key as the `DEVELOCITY_API_TOKEN` environment variable when using the library
1212

1313
## Migrating from macOS keychain support
1414

@@ -22,9 +22,9 @@ If you used the key from keychain and need a drop-in replacement:
2222
echo 'alias ge-api-token="security find-generic-password -w -a "$LOGNAME" -s gradle-enterprise-api-kotlin"' >> ~/.zshrc
2323
2424
# Retrieve it to the environment variable before running the program
25-
GRADLE_ENTERPRISE_API_TOKEN="$(ge-api-token)" ./my-script.main.kts
26-
GRADLE_ENTERPRISE_API_TOKEN="$(ge-api-token)" jupyter lab
27-
GRADLE_ENTERPRISE_API_TOKEN="$(ge-api-token)" idea my-project
25+
DEVELOCITY_API_TOKEN="$(ge-api-token)" ./my-script.main.kts
26+
DEVELOCITY_API_TOKEN="$(ge-api-token)" jupyter lab
27+
DEVELOCITY_API_TOKEN="$(ge-api-token)" idea my-project
2828
```
2929

3030
[1]: https://docs.gradle.com/enterprise/api-manual/#access_control

0 commit comments

Comments
 (0)