Skip to content

Conversation

@bnbong
Copy link
Owner

@bnbong bnbong commented Jul 10, 2025

Requesting Merging

Description

  • add template inspection step of docker-compose
  • add fastapi-mcp template
  • edit template insepction github actions workflow

Type of Change

  • BUG FIX
  • ADDING NEW FEATURES
  • FEATURE UPDATE
  • HOTFIX
  • DELETING UNNECESSARY FEATURES
  • DOCUMENTATION & DEVOPS
  • Etc..

Test Environment

localhost, MacOS M1

Major Changes

Same as mentioned above

Screenshots (optional)

Etc

pre-PR request for test edited github actions workflow

…se, add fastapi-mcp template, add template-config.yaml at template fastapi-psql-orm, edited template inspection github actions workflow
@bnbong bnbong requested a review from Copilot July 10, 2025 02:15
@bnbong bnbong self-assigned this Jul 10, 2025
@gitguardian
Copy link

gitguardian bot commented Jul 10, 2025

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
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
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. 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


🦉 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.

@github-actions github-actions bot added the template Add or editing a FastAPI template label Jul 10, 2025
@bnbong

This comment was marked as resolved.

Copy link
Contributor

Copilot AI left a 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-orm and fastapi-mcp templates under fastapi_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 run assumes PDM is installed and configured. Consider documenting this requirement or providing a fallback to plain python invocation.
          pdm run python scripts/inspect-templates.py --templates "${{ github.event.inputs.templates }}" --output template_inspection_results.json

@bnbong bnbong added the enhancement New feature or request label Jul 10, 2025
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 70.32258% with 92 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/fastapi_fastkit/backend/inspector.py 70.32% 92 Missing ⚠️

📢 Thoughts on this report? Let us know!

@bnbong bnbong merged commit 424c2bc into main Jul 10, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request template Add or editing a FastAPI template

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants