Skip to content

Conversation

@matyama
Copy link

@matyama matyama commented Jul 8, 2025

Purpose

Publish an example of some common paths that the user might want to exclude from the container.

Specification

This patch adds a basic .oakappignore file which ignores common Python venvs, node_modules, and git/CI stuff.

Dependencies & Potential Impact

None / not applicable

Deployment Plan

None / not applicable

Testing & Validation

Tested by building the example app from this repository with a local Python .venv and checked the contents of the app layer (verified that .venv is not present).

lz4 -d lower-2.tar.lz4 -c | tar -xvf -
...tree -a app
app
├── .gitignore
├── main.py
├── .oakappignore
├── README.md
├── requirements.txt
└── utils
    ├── __init__.py
    └── snaps_producer.py

2 directories, 7 files

This patch adds a basic `.oakappignore` file that which ignores common
Python venvs, node_modules, and git/CI stuff.
@alesh-kajzar
Copy link

@jakaskerl could you please review & merge this?

@jakaskerl jakaskerl self-requested a review July 10, 2025 11:17
Copy link
Collaborator

@jakaskerl jakaskerl left a comment

Choose a reason for hiding this comment

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

Maybe add .env as well. Is there an instance where it would not be best if we ignored all . (dot) files anyway?

This commit includes paths that will be ignored by default to the
`.oakappignore`. These entries can be included by uncommenting
respective lines and thus overriding the ignore prelude.
@matyama
Copy link
Author

matyama commented Jul 10, 2025

Maybe add .env as well. Is there an instance where it would not be best if we ignored all . (dot) files anyway?

IMHO this quite depends on the project. I've seen people using .env as a default config and just ignoring .envrc. In general, I wanted to kick this off and leave specifics for later (but I'm open to suggestions / including more entries here).

Also, after a discussion with @alesh-kajzar and brief testing, I pushed a commit with (commented out) overrides for paths that are ignored by default (in case someone really wants to include these).

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.

3 participants