Improved the docs re. fetching tags #33
Merged
Conversation
This file contains 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
Suggested a simpler approach to getting all tags. This approach is simpler and it has an additional benefit: it helps the "shipkit-changelog" plugin get all necessary commits to generate release notes.
koral--
approved these changes
Oct 31, 2020
README.md
Outdated
| @@ -31,9 +31,11 @@ version=1.0.* | |||
| 2. Apply `org.shipkit.shipkit-auto-version` to the root project. | |||
|
|
|||
| 3. Important! When using this plugin on CI make sure that your CI includes tags when making checkout. | |||
| For example, when using GitHub actions, you need add something this: | |||
| For example, the easiest way to achieve this with GitHub actions is to tweak 'fetch-depth': | |||
| ``` | |||
There was a problem hiding this comment.
Out of the scope of changes, but we can use ```yaml here.
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.
Suggested a simpler approach for getting all tags. This approach is simpler and it has an additional benefit: it helps the "shipkit-changelog" plugin get all necessary commits to generate release notes. Related to shipkit/shipkit-changelog#26