Docs Feedback: Shallow cloning with GIT_DEPTH: 1

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem to solve

Documentation on shallow cloning is a bit vague on how using a depth of 1 and a queue of jobs may cause a job to fail. A customer reported in this support ticket (internal) that the documentation is confusing regarding on how jobs can fail with GIT_DEPTH: 1, and they cannot get an error with the described scenario in the docs.

Further details

  • We're wondering if the warning on the docs still valid.
  • Jobs are not failing because fetch is always going after the pipeline ref associated to the specific CI_COMMIT_SHA of the pipeline.

Proposal

  • Confirm if the warning in the shallow cloning documentation for GIT_DEPTH: 1 still valid.
  • If it is, provide/explain an exact scenario that would cause this failure.
  • If it is not, update the documentation to remove the warning.

Who can address the issue

Other links/references

Edited by 🤖 GitLab Bot 🤖