-
Notifications
You must be signed in to change notification settings - Fork 1
[ADD, TEMPLATE] add a inspection of template which using docker compose, add fastapi-mcp template #7
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
Conversation
…se, add fastapi-mcp template, add template-config.yaml at template fastapi-psql-orm, edited template inspection github actions workflow
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 18424030 | Triggered | Username Password | 474456a | src/fastapi_fastkit/fastapi_project_template/fastapi-mcp/README.md-tpl | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
This comment was marked as resolved.
This comment was marked as resolved.
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 enhances template inspection to support Docker Compose testing, introduces two new FastAPI project templates (fastapi-psql-orm and fastapi-mcp), and updates documentation and CI workflow to cover the new template creation guide.
- Extend TemplateInspector to load
template-config.yml, check Docker availability, and run Docker‐based tests (with extensive new tests). - Add
fastapi-psql-ormandfastapi-mcptemplates underfastapi_project_template, including scaffolding, config, scripts, and test suites. - Update MkDocs navigation and GitHub Actions workflow to include the template creation guide and use
pdm run.
Reviewed Changes
Copilot reviewed 43 out of 44 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_backends/test_inspector.py | Added JSON import, mock_open import, and new tests for config loading, Docker checks, and script handling |
| src/fastapi_fastkit/fastapi_project_template/fastapi-psql-orm/template-config.yml-tpl | New template configuration for PostgreSQL ORM template |
| src/fastapi_fastkit/fastapi_project_template/fastapi-mcp/** | New MCP template scaffold: tests, source code, config, scripts, and CI setup |
| .github/workflows/template-inspection.yml | Switched inspection step to use pdm run python |
| mkdocs.yml | Added “Template Creation Guide” to navigation |
Comments suppressed due to low confidence (2)
src/fastapi_fastkit/fastapi_project_template/fastapi-mcp/tests/test_items.py-tpl:79
- This test function defines an update scenario but contains no assertions. Add explicit assertions to verify the expected outcome of the update.
def test_update_item_with_auth(client: TestClient, auth_headers):
.github/workflows/template-inspection.yml:34
- [nitpick] Switching to
pdm runassumes PDM is installed and configured. Consider documenting this requirement or providing a fallback to plainpythoninvocation.
pdm run python scripts/inspect-templates.py --templates "${{ github.event.inputs.templates }}" --output template_inspection_results.json
src/fastapi_fastkit/fastapi_project_template/fastapi-psql-orm/template-config.yml-tpl
Outdated
Show resolved
Hide resolved
…template-config.yml-tpl Co-authored-by: Copilot <[email protected]>
|
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
Requesting Merging
Description
Type of Change
Test Environment
localhost, MacOS M1
Major Changes
Same as mentioned above
Screenshots (optional)
Etc
pre-PR request for test edited github actions workflow