Skip to content

Commit

Permalink
DOC: Show how to unshallow actions/checkout
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Aug 30, 2023
1 parent d9037a3 commit b214bf3
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,20 @@ Caveats

__ https://docs.readthedocs.io/en/latest/build-customization.html#unshallow-git-clone

If you want to get rid of the warning (without actually fixing the problem),
This might also happen when using Github Actions,
because `actions/checkout`__ also uses shallow clones by default.
This can be changed by using ``fetch-depth: 0``:

.. code:: yaml
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
__ https://github.com/actions/checkout

If you only want to get rid of the warning (without actually fixing the problem),
use this in your ``conf.py``::

suppress_warnings = ['git.too_shallow']
Expand Down

0 comments on commit b214bf3

Please sign in to comment.