Remove exposed OpenWeather key from guide samples - #529
Merged
Conversation
Replace the committed appid with an optional environment variable placeholder and remove the screenshot that reveals the key. Assisted-by: opencode:gpt-5.6-sol codegraph playwright
Replace the committed appid with an optional environment variable placeholder and remove the screenshot that reveals the key. Assisted-by: opencode:gpt-5.6-sol codegraph playwright
Update both guide versions so their run instructions match the environment-backed API key configuration. Assisted-by: opencode:gpt-5.6-sol codegraph playwright
Contributor
There was a problem hiding this comment.
Pull request overview
Removes a previously hard-coded OpenWeather API key from the Grails Mock HTTP Server guides by replacing it with an environment-variable placeholder, and removes guide content that displayed the key in a screenshot.
Changes:
- Replace the live
openweather.appidvalue in both Grails 3 and Grails 4application.ymlsnippets with${OPENWEATHER_APPID:}. - Update “running the app” instructions to tell readers to set
OPENWEATHER_APPID. - Remove
apiKey.pngscreenshot references from both guide versions.
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| guides/grails-mock-http-server/v4/snippets/grails-app/conf/application.yml | Replaces the embedded OpenWeather key with an env-var placeholder. |
| guides/grails-mock-http-server/v4/guide/runningTheApp.adoc | Updates run instructions to reference OPENWEATHER_APPID. |
| guides/grails-mock-http-server/v4/guide/openweather.adoc | Removes the API-key screenshot reference. |
| guides/grails-mock-http-server/v3/snippets/grails-app/conf/application.yml | Replaces the embedded OpenWeather key with an env-var placeholder. |
| guides/grails-mock-http-server/v3/guide/runningTheApp.adoc | Updates run instructions to reference OPENWEATHER_APPID. |
| guides/grails-mock-http-server/v3/guide/openweather.adoc | Removes the API-key screenshot reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
OPENWEATHER_APPIDenvironment placeholderThis intentionally updates the current branch only and does not rewrite repository history.
Companion current-guide source PR: grails-guides/grails-mock-http-server#6
Verification
./gradlew clean check --no-daemon --no-configuration-cache./gradlew renderGuide_grails_mock_http_server_3 renderGuide_grails_mock_http_server_4 --no-daemon --no-configuration-cache