Checkout action requirement is missing from the docs #542
Assignees
Labels
enhancement
New feature or request
Comments
Merged
|
Hi @dstrants, thanks for your feedback and your offer to make the update. The details about this are nuanced, and not every repo will require this to be added. The advice is only to include it if the task returns this as a specific error message. I've now included details around this in the docs as suggested. |
Merged
muiriswoulfe
added a commit
that referenced
this issue
Sep 23, 2024
## Summary This change includes updates to the documentation to provide guidance on handling Git history during checkout in Azure Pipelines. The changes are primarily focused on ensuring users understand how to fetch the necessary Git history and avoid issues related to non-linear history. This addresses #542. Documentation Updates: * [`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R151-R170): Added a new section on Git History, explaining the need to fetch Git history during checkout and providing instructions on how to update the `actions/checkout` step. * [`docs/azure-pipelines-task.md`](diffhunk://#diff-6ad131ef75795fdec5e164a1caceb5849fa2ee34df8e487d31e02ff146f957f5L97-R131): Added a similar section on Git History, detailing how to fetch Git history during checkout in Azure Pipelines and providing alternatives for classic pipelines.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
We started using the action and after a couple of failures that the checkout action is required with
fetch-depth: 0in order for the action properly operate.I checked the readme again and could not find any reference to that although it is a prerequisite.
I'd be happy to add the missing information myself but I am not sure where would be the right place to do so in the readme. Probably a full action example would be most helpful
The text was updated successfully, but these errors were encountered: