docs(retry): Updated docs to include how to run --retry from a npm script #158
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
|
@jimthedev @kentcdodds Not sure what you guys think, since it is a cli, but it's just to clarify for newbies, like myself, that are not aware of the need to use double |
|
|
||
| Please note that the retry cache may be cleared when upgrading commitizen versions, upgrading adapters, or if you delete the `commitizen.json` file in your home or temp directory. Additionally, the commit cache uses the filesystem path of the repo, so if you move a repo or change its path, you will not be able to retry a commit. This is an edge case, but might be confusing if you have scenarios where you are moving folders that contain repos. | ||
| Please note that the retry cache may be cleared when upgrading commitizen versions, upgrading adapters, or ifx you delete the `commitizen.json` file in your home or temp directory. Additionally, the commit cache uses the filesystem path of the repo, so if you move a repo or change its path, you will not be able to retry a commit. This is an edge case, but might be confusing if you have scenarios where you are moving folders that contain repos. |
|
I updated the docs to try to reflect your notes. I apologize for any grammar or other mistake in advance. Thanks for all the patience guys. |
|
LGTM |
|
@lricoy Looks great. Can you please rebase to squash these commits into one? Cheers. |
There are multiple ways to pass the --retry option to a npm script. This change updates the docs to explain some of them. references commitizen#132
|
@jimthedev done. I hope this is what you meant |
|
I believe so. In the future @jimthedev, maybe you could say:
👍 |
|
@kentcdodds Yes. Good idea. :) |
jimthedev
added a commit
that referenced
this pull request
Mar 15, 2016
docs(retry): Updated docs to include how to run --retry from a npm script
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.
To run git-cz with the --retry option from a npm script we need to do: 'npm run -- --retry'
references #132