Skip to content
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

Add ignore rules for Pipenv #2977

Merged
merged 4 commits into from
Mar 11, 2019
Merged

Add ignore rules for Pipenv #2977

merged 4 commits into from
Mar 11, 2019

Conversation

JarryShaw
Copy link
Contributor

Pipenv uses Pipfile.lock to maintain Python package information
(metadata, hash, etc.) installed as described in Pipfile. Thus,
Pipfile.lock may vary on different operating systems, platforms
when collaborating. This PR adds Pipfile.lock into the Python
default gitignore. See http://pipenv.org

Pipenv uses Pipfile.lock to maintain Python package information
(metadata, hash, etc.) installed as described in Pipfile. Thus,
Pipfile.lock may vary on different operating systems, platforms
when collaborating. This PR adds Pipfile.lock into the Python
default gitignore. See http://pipenv.org
@drothmaler
Copy link
Contributor

According to the Pipenv docs and pypa/pipenv#598 it is generally recommended to add Pipfile.lock to the VCS, unless you have a specific reason not do do so (e.g. if you are targeting multiple Python versions, or if you are dealing with legacy dependencies, that are not platform-agnostic).

So -1 for adding it by default.
But it might be nice to add it as an commented Opt-In ignore. Something like

# you might want to ignore the pipenv lock-file if ... bla bla bla
# Pipfile.lock

Not to ignore Pipfile.lock in default, but explain
when and why it should be ignored in case of
collaboration. (adjusted according to comment
in github#2977 by @drothmaler )
@JarryShaw
Copy link
Contributor Author

Noted. Adjusted according to @drothmaler 's comment.

Python.gitignore Outdated Show resolved Hide resolved
Python.gitignore Outdated Show resolved Hide resolved
shiftkey and others added 2 commits March 9, 2019 10:37
Co-Authored-By: JarryShaw <jarryshaw@icloud.com>
As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.
Copy link
Member

@shiftkey shiftkey left a comment

Choose a reason for hiding this comment

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

Thanks @JarryShaw!

@shiftkey shiftkey merged commit 7079791 into github:master Mar 11, 2019
kiku-jw pushed a commit to kiku-jw/gitignore that referenced this pull request Apr 6, 2019
* Add ignore rules for Pipenv

Pipenv uses Pipfile.lock to maintain Python package information
(metadata, hash, etc.) installed as described in Pipfile. Thus,
Pipfile.lock may vary on different operating systems, platforms
when collaborating. This PR adds Pipfile.lock into the Python
default gitignore. See http://pipenv.org

* Update Python.gitignore

Not to ignore Pipfile.lock in default, but explain
when and why it should be ignored in case of
collaboration. (adjusted according to comment
in github#2977 by @drothmaler )

* Apply suggestions from code review

Co-Authored-By: JarryShaw <jarryshaw@icloud.com>

* Update Python.gitignore

As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.
Ortega-Dan pushed a commit to Ortega-Dan/gitignore that referenced this pull request Jun 26, 2019
* Add ignore rules for Pipenv

Pipenv uses Pipfile.lock to maintain Python package information
(metadata, hash, etc.) installed as described in Pipfile. Thus,
Pipfile.lock may vary on different operating systems, platforms
when collaborating. This PR adds Pipfile.lock into the Python
default gitignore. See http://pipenv.org

* Update Python.gitignore

Not to ignore Pipfile.lock in default, but explain
when and why it should be ignored in case of
collaboration. (adjusted according to comment
in github#2977 by @drothmaler )

* Apply suggestions from code review

Co-Authored-By: JarryShaw <jarryshaw@icloud.com>

* Update Python.gitignore

As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants