feat: add Python Functions entries to the template .gitignore
#542
Conversation
This file contains 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
Python support for Salesforce Functions is currently in beta. When working on a Python project, it's typical to install the project's dependencies inside a Python "virtual environment". This environment is typically placed inside the project directory, with a directory name of `.venv` or `venv`. This environment is machine-specific, so must not be committed to source control. In addition, when Python files are run, the Python interpreter writes the generated bytecode to disk, as a performance improvement for subsequent invocations. This bytecode is stored under `__pycache__` directories alongside the source code, and is environment-specific so similarly should not be committed to source control. Currently the beta docs for Python Functions have the user manually edit their project's `.gitignore`, however this adds friction and a potential source of mistakes, so we should add these entries to the template directly. GUS-W-12198175.
|
Thanks for contributing @edmorley ! 🙌🏼😁 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Python support for Salesforce Functions is currently in beta.
When working on a Python project, it's typical to install the project's dependencies inside a Python "virtual environment". This environment is typically placed inside the project directory, with a directory name of
.venvorvenv. This environment is machine-specific, so must not be committed to source control.In addition, when Python files are run, the Python interpreter writes the generated bytecode to disk, as a performance improvement for subsequent invocations. This bytecode is stored under
__pycache__directories alongside the source code, and is environment-specific so similarly should not be committed to source control.Currently the beta docs for Python Functions have the user manually edit their project's
.gitignore, however this adds friction and a potential source of mistakes, so we should add these entries to the template directly.What issues does this PR fix or reference?
@W-12198175@