-
Notifications
You must be signed in to change notification settings - Fork 4
[RELEASE, DOCS, FIX] Fix fastkit init flow, address security advisories & review findings #40
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
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5989dcd
[DOCS] update user guides - contributing
bnbong 9aea174
[DOCS] update FAQ.md
bnbong c9d1d5d
[FIX] fix fastkit init flow, add failure takeover logic
bnbong 571c421
[RELEASE] update 1.2.1
bnbong b8567b4
[FIX] fix dependabot alerts
bnbong 10d6436
[TEST] cover Codecov patch-coverage gaps on PR #40
bnbong 9cbf801
[FIX] parse PEP 508 requirements in PoetryManager.generate_dependency…
bnbong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -15,6 +15,7 @@ Adding a new template follows a 5-step process: | |||||
| ## 📋 Step 1: Planning & Design | ||||||
|
|
||||||
| ### Define Template Purpose | ||||||
|
|
||||||
| Before creating a new template, answer these questions: | ||||||
|
|
||||||
| - **What is the unique value of this template?** | ||||||
|
|
@@ -34,6 +35,7 @@ Examples: | |||||
| - `fastapi-auth-jwt` (JWT authentication template) | ||||||
|
|
||||||
| ### Technology Stack Planning | ||||||
|
|
||||||
| Pre-define the main technologies to include: | ||||||
|
|
||||||
| ```yaml | ||||||
|
|
@@ -226,6 +228,7 @@ setup( | |||||
| ``` | ||||||
|
|
||||||
| #### 4. Writing Test Files | ||||||
|
|
||||||
| ```python | ||||||
| # tests/test_items.py-tpl | ||||||
| """ | ||||||
|
|
@@ -285,32 +288,39 @@ make inspect-template TEMPLATES="fastapi-your-template" | |||||
| python scripts/inspect-templates.py --templates "fastapi-your-template" --verbose | ||||||
| ``` | ||||||
|
|
||||||
| > **Note:** When you submit a PR, the **Template PR Inspection** workflow will automatically run and validate your template changes. You'll receive feedback directly on your PR. | ||||||
| !!! note | ||||||
|
|
||||||
| When you submit a PR, the **Template PR Inspection** workflow will automatically run and validate your template changes. You'll receive feedback directly on your PR. | ||||||
|
|
||||||
| ### Validation Checklist | ||||||
|
|
||||||
| The inspector automatically validates the following items: | ||||||
|
|
||||||
| #### ✅ File Structure Validation | ||||||
|
|
||||||
| - [ ] `tests/` directory exists | ||||||
| - [ ] `requirements.txt-tpl` file exists | ||||||
| - [ ] `setup.py-tpl` file exists | ||||||
| - [ ] `README.md-tpl` file exists | ||||||
|
|
||||||
| #### ✅ File Extension Validation | ||||||
|
|
||||||
| - [ ] All Python files use `.py-tpl` extension | ||||||
| - [ ] No `.py` extension files exist | ||||||
|
|
||||||
| #### ✅ Dependencies Validation | ||||||
|
|
||||||
| - [ ] `requirements.txt-tpl` includes `fastapi` | ||||||
| - [ ] `setup.py-tpl`'s `install_requires` includes `fastapi` | ||||||
| - [ ] `setup.py-tpl`'s description includes `[fastapi-fastkit templated]` | ||||||
|
|
||||||
| #### ✅ FastAPI Implementation Validation | ||||||
|
|
||||||
| - [ ] `FastAPI` import exists in `main.py-tpl` | ||||||
| - [ ] App creation like `app = FastAPI()` exists in `main.py-tpl` | ||||||
|
|
||||||
| #### ✅ Test Execution Validation | ||||||
|
|
||||||
| - [ ] Virtual environment creation successful | ||||||
| - [ ] Dependencies installation successful | ||||||
| - [ ] All pytest tests pass | ||||||
|
|
@@ -345,7 +355,7 @@ New templates are **automatically discovered** and tested without manual configu | |||||
| 4. ✅ **Comprehensive Validation**: Structure, metadata, and functionality checks | ||||||
|
|
||||||
| **What This Means for You:** | ||||||
| - 🚀 **No Additional Test Files**: Your template is tested automatically | ||||||
| - 🚀 **No Additional Test Files at `FastAPI-fastkit`'s main source testcases**: Your template is tested automatically | ||||||
|
||||||
| - 🚀 **No Additional Test Files at `FastAPI-fastkit`'s main source testcases**: Your template is tested automatically | |
| - 🚀 **No Additional Test Files at `FastAPI-fastkit`'s main source test cases**: Your template is tested automatically |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.