Skip to content

docs: Update Flash docs for .flashignore deprecation and built-in ignore patterns#588

Open
promptless[bot] wants to merge 1 commit intomainfrom
promptless/flash-flashignore-deprecation
Open

docs: Update Flash docs for .flashignore deprecation and built-in ignore patterns#588
promptless[bot] wants to merge 1 commit intomainfrom
promptless/flash-flashignore-deprecation

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 23, 2026

Open this suggestion in Promptless to view citations and reasoning process

Removes .flashignore references 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 .env variants (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)

  • Reviewed runpod/flash#220
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Viewed flash/apps/initialize-project.mdx
  • Viewed flash/cli/init.mdx
  • Viewed flash/troubleshooting.mdx
  • Viewed flash/apps/deploy-apps.mdx
  • Viewed flash/apps/build-app.mdx
  • Viewed flash/cli/build.mdx

Agent Response

I've created a documentation update for PR #220 which replaces .flashignore with built-in ignore patterns.

Summary of changes:

  1. Removed .flashignore from project structure trees in:

    • flash/apps/initialize-project.mdx
    • flash/cli/init.mdx
    • flash/apps/build-app.mdx
  2. Updated troubleshooting guidance (flash/troubleshooting.mdx) to recommend adding large files to .gitignore instead of .flashignore

  3. Updated deploy-apps.mdx to reference the new built-in ignore patterns documentation instead of .flashignore

  4. Added new "Built-in ignore patterns" section to flash/cli/build.mdx documenting:

    • All automatically excluded file patterns (build artifacts, virtual environments, IDE files, environment files, tests, and documentation)
    • How to add custom exclusions via .gitignore
    • A deprecation note for users migrating from .flashignore

The suggestion is ready for review at https://app.gopromptless.ai/suggestions/e1498a5f-d4ab-4373-84b2-b6c521884de4

runpod/flash PR #280: fix: exclude .env files from deploy artifact by default

Promptless Research (4 files, 1 GitHub PR)

  • Reviewed runpod/flash#280
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Viewed flash/cli/build.mdx

Agent Response

I've reviewed PR #280 and updated the documentation accordingly.

Summary

PR #280 adds .env and .env.* to Flash's built-in ignore patterns, preventing accidental upload of local development secrets (like API keys in .env files) to deployed workers. This is a security improvement.

Documentation Update

I updated the existing suggestion for Flash .flashignore deprecation to accurately reflect this change:

Change made in flash/cli/build.mdx:

  • Updated the "Environment files" row in the built-in ignore patterns table from .env, .env.local to .env, .env.*

This ensures the documentation accurately shows that all .env variants (.env.local, .env.production, .env.staging, etc.) are excluded from deploy artifacts, not just .env.local.

The change was added to the existing suggestion since it directly relates to the same feature: Flash's built-in ignore patterns that replaced .flashignore.


Tip: Set up a GitHub Issues trigger in Projects to enable @Promptless mentions in issues 🐙

@@ -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`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(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

| 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.*` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@mintlify
Copy link

mintlify bot commented Mar 23, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 23, 2026, 9:40 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants