Migrate to the OSS Community Develocity Instance#2381
Conversation
Point Develocity server URL to https://community.develocity.cloud and tag scans with projectId "spockframework", replacing the self-hosted ge.spockframework.org instance. README badge link updated to match. The ToU fallback for unauthenticated CI runs and locally-requested scans is preserved as-is.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe Develocity server endpoint is migrated from ChangesDevelocity Server and Secret Migration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
leonard84
left a comment
There was a problem hiding this comment.
This is a good opportunity to rename the secret from GRADLE_ENTERPRISE_ACCESS_KEY to DEVELOCITY_ACCESS_KEY. The GE will have the old credentials, and the new DV one is set up for the new instance. Could you modify the workflow accordingly?
| } | ||
|
|
||
| develocity { | ||
| projectId = "spockframework" |
There was a problem hiding this comment.
Are we now limited to a single project? Otherwise, this should probably be spockframework/spock or spockframework-spock if / is not allowed.
There was a problem hiding this comment.
This is not 1:1 with Gradle projects and different from rootProject.name. You can have multiple Gradle projects using this same projectId. The projectId refers to an isolated namespace in terms of build scans and build cache that only your users are authorized to write to (Project-Level Access Control). It was named after the spockframework GitHub org. Does this clarify? Let me know if the name makes sense considering this.
There was a problem hiding this comment.
Ok, I checked the docs first, but they don't make this clear.
Then, it should stay this way.
The Gradle Enterprise to Develocity rename is now several years old, and the OSS Community Develocity migration is a natural point to retire the legacy secret name. Update common.main.kts to declare the secret as DEVELOCITY_ACCESS_KEY and regenerate the affected workflow YAMLs.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/common.main.kts:
- Around line 35-39: Change the source of the DEVELOCITY_ACCESS_KEY variable
assignment on line 35 from secrets.DEVELOCITY_ACCESS_KEY to
secrets.GRADLE_ENTERPRISE_ACCESS_KEY, reading from the legacy secret name
instead. Keep the commonCredentials mapping unchanged so that the value is still
mapped to the new DEVELOCITY_ACCESS_KEY environment variable name. This ensures
CI reads from the existing legacy secret while correctly mapping it to the new
environment variable during the migration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f001dde7-1dcb-4acd-8214-a42546828a20
📒 Files selected for processing (3)
.github/workflows/branches-and-prs.yaml.github/workflows/common.main.kts.github/workflows/release.yaml
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2381 +/- ##
=========================================
Coverage 82.32% 82.33%
- Complexity 4876 4878 +2
=========================================
Files 474 474
Lines 15205 15205
Branches 1935 1935
=========================================
+ Hits 12518 12519 +1
Misses 1993 1993
+ Partials 694 693 -1 🚀 New features to boost your workflow:
|
This PR moves Spock's Build Scan publishing and remote Build Cache from
the self-hosted
ge.spockframework.orginstance to the OSS CommunityDevelocity Instance at https://community.develocity.cloud under
project ID
spockframework.What this PR changes
settings.gradle: new Develocity server URL and Project-Level AccessControl ID.
README.adoc: "Revved up by Develocity" badge linkGRADLE_ENTERPRISE_ACCESS_KEYto
DEVELOCITY_ACCESS_KEYNothing else is touched: plugin versions, the Terms-of-Use fallback for
unauthenticated CI runs /
--scanand the HTTP build cache fallback are allpreserved.
Step 1: Get an access key for
community.develocity.cloudteam has provisioned for spockframework — that account was shared
with you out-of-band when this onboarding was set up. The access key
inherits that account's project memberships and permissions, which
is exactly what you want for CI.
keys.
GitHub Actions), and copy the generated key. Keep this tab openuntil you complete Step 2 — the key is only shown once.
Step 2: Add the
DEVELOCITY_ACCESS_KEYsecret on this repositoryCI exposes a repository secret named
DEVELOCITY_ACCESS_KEYto the build as
DEVELOCITY_ACCESS_KEY(via.github/workflows/common.main.kts). The secret name stays thesame; only the value needs to change to point at the new instance.
Open this repository on GitHub.
Click Settings.
In the left sidebar, click Secrets and variables → Actions.
Find the
DEVELOCITY_ACCESS_KEYsecret and click Update.Set the new value to the line below, replacing
PASTE_THE_ACCESS_KEY_FROM_STEP_1_HEREwith the key you copied inStep 1:
The
community.develocity.cloud=prefix is required — withoutthe host name, the access key is silently ignored. This is the most
common point of failure when onboarding, so please double-check the
format.
Click Update secret.
Step 3: Provision an access key for your local builds
Developers building spock locally should provision a personal access
key for
community.develocity.cloudso their Build Scans publish andthey get reads from the remote Build Cache. The Develocity Gradle
plugin's
provisionDevelocityAccessKeytask does this in a singlecommand — it opens the browser, asks the developer to confirm, and
writes the key to
~/.gradle/develocity/keys.propertiesautomatically.Before running this command, sign out of
community.develocity.cloudin your browser (or use aprivate/incognito window) so the access key gets associated with
your personal account, not the CI service account you signed in
as for Step 1.
Note on the CI run on this PR
This PR was prepared from a fork. Forks can't read this repository's
secrets, which means the workflow run on this PR cannot publish to
community.develocity.cloud. If you'd rather see a scan published tothe new instance before merging, you're welcome to reopen this PR from
your own account.