-
Notifications
You must be signed in to change notification settings - Fork 1
Add comprehensive Copilot instructions for meshStack Terraform Provider #50
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: main
Are you sure you want to change the base?
Conversation
Co-authored-by: j0g3sc <59925842+j0g3sc@users.noreply.github.com>
Co-authored-by: j0g3sc <59925842+j0g3sc@users.noreply.github.com>
|
@JohannesRudolph Thanks for the hint. |
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.
lgtm for a first pass, will be refined based on real world performance anyway
**Key Information:** | ||
- **Purpose**: Manage meshStack cloud resources (projects, workspaces, tenants, building blocks, etc.) using Terraform | ||
- **API Integration**: Uses the meshStack meshObject API (`/api/meshobjects` endpoints) | ||
- **API Documentation**: https://docs.dev.meshcloud.io/api/index.html#mesh_objects |
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.
- **API Documentation**: https://docs.dev.meshcloud.io/api/index.html#mesh_objects | |
- **API Documentation**: https://docs.meshcloud.io/api/index.html#mesh_objects |
- **Purpose**: Manage meshStack cloud resources (projects, workspaces, tenants, building blocks, etc.) using Terraform | ||
- **API Integration**: Uses the meshStack meshObject API (`/api/meshobjects` endpoints) | ||
- **API Documentation**: https://docs.dev.meshcloud.io/api/index.html#mesh_objects | ||
- **Provider Registry**: https://registry.terraform.io/providers/meshcloud/meshstack/latest/docs |
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.
d: we also publish to opentofu registry
└── templates/ # Documentation templates | ||
``` | ||
|
||
### API Authentication |
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.
d: not sure if this is wasted context (auth is already codified in the provider)
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.
a more useful explanation here would be the key concept of workspace and that most resources live in a workspace, and that API tokens are also usually scoped to a single workspace
This PR adds a comprehensive
.copilot-instructions.md
file to provide GitHub Copilot with detailed context about the meshStack Terraform Provider repository structure, development patterns, and API integration.What's included
The instructions file covers:
/internal/provider/
,/client/
,/docs/
,/examples/
)Key information for Copilot
The instructions provide essential context about:
/api/meshobjects
endpoints)This will enable Copilot to provide more accurate and contextually relevant assistance to developers working on the provider.
Fixes #49.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.