-
Notifications
You must be signed in to change notification settings - Fork 6
example improvements #1075
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: rc-v0.5.16
Are you sure you want to change the base?
example improvements #1075
Conversation
…ovider information. Update links and improve user prompts for GCP and Microsoft 365 configurations, ensuring users are informed when values need to be manually filled in. This improves the robustness of the initialization script.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR improves the example repository infrastructure by adding AI agent documentation and enhancing initialization scripts to gracefully handle missing platform-specific CLI tools.
Key changes:
- Added AGENTS.template.md files for both GCP and AWS examples to guide AI agents in understanding and assisting with repository usage
- Updated initialization scripts to suppress error output and provide fallback values when platform CLIs (gcloud, az) are unavailable
- Changed documentation reference from GitHub URL to docs.worklytics.co
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tools/release/example-copy.sh | Added logic to copy AGENTS.template.md file if it exists to example repositories |
| tools/init-tfvars.sh | Enhanced error handling to gracefully manage missing CLI tools (gcloud, az) and provide fallback values with user warnings |
| infra/examples-dev/gcp/AGENTS.template.md | New AI agent guide documenting the GCP example repository structure, purpose, and common tasks |
| infra/examples-dev/aws/AGENTS.template.md | New AI agent guide documenting the AWS example repository structure, purpose, and common tasks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on February 10
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
Features
Change implications
Note
Adds AI Agent guides for the AWS and GCP example repos and hardens initialization scripts for environments lacking cloud CLIs/providers.
AGENTS.template.mdininfra/examples-dev/awsandinfra/examples-dev/gcpdescribing example repo purpose, setup, and troubleshootingtools/init-tfvars.sh: suppressesterraform providersstderr, guardsaws/gcloud/azcalls, fills placeholders when values can’t be detected, refines prompts/messages, updates AWS docs URL, and conditionally skips/removes Google Workspace/Microsoft 365 configtools/release/example-copy.sh: copiesREADME.template.mdtoREADME.mdand, if present,AGENTS.template.mdtoAGENTS.mdWritten by Cursor Bugbot for commit 10b24b7. This will update automatically on new commits. Configure here.