Skip to content

Commit

Permalink
Update .gitignore example
Browse files Browse the repository at this point in the history
  • Loading branch information
dolfinus committed Apr 8, 2024
1 parent e61e086 commit 16ac44f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/common_issues/all_dirty.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is usually caused by some files created by CI pipeline like build
artifacts or test reports, e.g. ``dist/my_package.whl`` or
``reports/unit.xml``. If they are not mentioned in ``.gitignore`` file
they will be recognized by git as untracked. Because of that
``git status`` will report that you have uncommitted (dirty) changes in
``git status`` will report that you have **uncommitted (dirty) changes** in
the index, so ``setuptools-git-versioning`` will detect current version
as ``dirty``.

Expand All @@ -18,5 +18,8 @@ In most the cases adding these lines solves the issue:

.. code:: gitignore
build/
dist/
eggs/
*.egg*
venv

0 comments on commit 16ac44f

Please sign in to comment.