Document action's fetch depth requirement #11
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The changelog is generated from the commit history. But the ubiquitous `actions/checkout` action does a shallow fetch by default. This works perfectly well for almost every usage, so many users may not even be aware of the shallowness of the resulting repository or the ability to control the behavior via that action's `fetch-depth` input. If you use the default `actions/checkout` configuration in your workflow, the resulting will contain, at most, a single entry. This can be extremely confusing. So the users will likely find some guidance in the required checkout configuration to be valuable.
per1234
added
topic: documentation
silvanocerza
approved these changes
Jun 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changelog is generated from the commit history. But the ubiquitous
actions/checkoutaction does a shallow fetch by default. This works perfectly well for almost every usage, so many users may not even be aware of the shallowness of the resulting repository or the ability to control the behavior via that action'sfetch-depthinput.If you use the default
actions/checkoutconfiguration in your workflow, the resulting will contain, at most, a single entry. This can be extremely confusing. So the users will likely find some guidance in the required checkout configuration to be valuable.The existing documentation structure didn't accommodate the addition of this information without significantly harming its readability. For this reason, I took the liberty of adding some headings to establish the necessary structure to contain the added content.