docs: Update Flash docs for .flashignore deprecation and built-in ignore patterns#588
docs: Update Flash docs for .flashignore deprecation and built-in ignore patterns#588promptless[bot] wants to merge 2 commits intomainfrom
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| @@ -52,6 +52,21 @@ Comma-separated list of packages to exclude from the build (e.g., `torch,torchvi | |||
| 5. **Dependency installation**: Installs Python packages for Linux x86_64. | |||
| 6. **Packaging**: Bundles everything into `.flash/artifact.tar.gz`. | |||
|
|
|||
There was a problem hiding this comment.
Citation: Built-in ignore patterns extracted from the new always_ignore list in src/runpod_flash/cli/utils/ignore.py. The PR adds these patterns to replace the .flashignore file.
View source
There was a problem hiding this comment.
(Line 82)
Citation: Deprecation note based on the PR description: "Add deprecation warning for users who still have a .flashignore file, guiding them to migrate custom patterns to .gitignore."
View source
flash/cli/build.mdx
Outdated
| | Build artifacts | `.build/`, `.flash/`, `.runpod/`, `*.tar.gz`, `.git/`, `__pycache__/`, `*.pyc`, `*.pyo`, `*.pyd`, `*.egg-info/`, `dist/`, `build/` | | ||
| | Virtual environments | `.venv/`, `venv/`, `env/` | | ||
| | IDE files | `.vscode/`, `.idea/` | | ||
| | Environment files | `.env`, `.env.*` | |
There was a problem hiding this comment.
Citation: Updated from .env.local to .env.* based on PR #280 which adds the .env.* glob pattern to always_ignore in cli/utils/ignore.py. This ensures all .env variants (.env.local, .env.production, .env.staging, etc.) are excluded from deploy artifacts.
View source
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
flash/cli/build.mdx
Outdated
| | Build artifacts | `.build/`, `.flash/`, `.runpod/`, `*.tar.gz`, `.git/`, `__pycache__/`, `*.pyc`, `*.pyo`, `*.pyd`, `*.egg-info/`, `dist/`, `build/` | | ||
| | Virtual environments | `.venv/`, `venv/`, `env/` | | ||
| | IDE files | `.vscode/`, `.idea/` | | ||
| | Environment files | `.env`, `.env.*` | |
There was a problem hiding this comment.
Citation: The QA report in PR #220 confirms only .env and .env.local are excluded (not .env.* wildcard). Implementation in src/runpod_flash/cli/utils/ignore.py shows ".env" and ".env.local" as specific patterns.
View source
| Flash also respects your `.gitignore` file and excludes any files matching those patterns. | ||
|
|
||
| ## Build artifacts | ||
|
|
There was a problem hiding this comment.
Citation: QA report notes: "No pattern for .env.* wildcard (only .env and .env.local are excluded; .env.dev, .env.staging etc. would be included). Users should add these to .gitignore if needed."
View source
Open this suggestion in Promptless to view citations and reasoning process
Removes
.flashignorereferences from Flash documentation and adds a new section documenting the built-in ignore patterns that now replace it. Users should migrate any custom patterns to.gitignore. The environment files pattern has been updated to.env.*to reflect that all.envvariants (not just.env.local) are excluded from deploy artifacts.Trigger Events
runpod/flash PR #220: feat(build): replace .flashignore with built-in ignore patterns
Promptless Research (9 files, 1 GitHub PR)
.long_term_context/product_knowledge/product_overview.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdflash/apps/initialize-project.mdxflash/cli/init.mdxflash/troubleshooting.mdxflash/apps/deploy-apps.mdxflash/apps/build-app.mdxflash/cli/build.mdxAgent Response
runpod/flash PR #280: fix: exclude .env files from deploy artifact by default
Promptless Research (4 files, 1 GitHub PR)
.long_term_context/product_knowledge/product_overview.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdflash/cli/build.mdxAgent Response
Tip: Set up a GitHub Issues trigger in Projects to enable @Promptless mentions in issues 🐙