Dockerfile with variable depth parameter (IDFGH-11513)

[timoxd7]

Problem

If a docker image is built from a branch that has a commit offset in respect to the last tag while using IDF_CLONE_SHALLOW, the git describe will fail returning "1".

Fix

Add another parameter to specify the depth instead of falling back to "1". If set to the offset of the commit +1, the git describe works again, still without cloning the whole repository. For custom IDF and development builds, this helps to get a working build version number again, instead of just "1" being put into the build es ESP IDF Version.

Backport

We use ESP-IDF v5.1.x, so a backport would be great.

[github-actions]

	Messages
📖	You might consider squashing your 3 commits (simplifying branch history).

---

👋 Welcome timoxd7, thank you for your first contribution to espressif/esp-idf project!

📘 Please check Contributions Guide for the contribution checklist, information regarding code and documentation style, testing and other topics.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for espressif/esp-idf project.

Pull request review and merge process you can expect

Espressif develops the ESP-IDF project in an internal repository (Gitlab). We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

1. An internal issue has been created for the PR, we assign it to the relevant engineer
2. They review the PR and either approve it or ask you for changes or clarifications
3. Once the Github PR is approved, we synchronize it into our internal git repository
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing
   • At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the master branch
6. On next sync from the internal git repository merged change will appear in this public Github repository

---

_{🔁 You can re-run automatic PR checks by retrying the DangerJS action}

Generated by 🚫 dangerJS against 7cfdec1

[timoxd7]

Fixed commit message as suggested

[igrr]

Thank you for the PR @timoxd7! Could you please add a line about this variable also to the docs over here:

esp-idf/docs/en/api-guides/tools/idf-docker-image.rst

Line 142 in a7fbf45

- ``IDF_CLONE_SHALLOW``: If this argument is set to a non-empty value, ``--depth=1 --shallow-submodules`` arguments are be used when performing ``git clone``. This significantly reduces the amount of data downloaded and the size of the resulting Docker image. However, if switching to a different branch in such a "shallow" repository is necessary, an additional ``git fetch origin <branch>`` command must be executed first.

[timoxd7]

@igrr Forgot about that, i have added it to this pull request and the backport one.

[igrr]

Thanks, looks good. Don't worry about the backport — since we will also need to update the Chinese version of the documentation (docs/zh_CN/api-guides/tools/idf-tools.rst), we will backport the final version together with the translation. We'll keep you as the commit author, of course.

[igrr]

sha=7cfdec1649466ff5cb3363803f5f31424c986deb