Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information about using ratchetFrom on CI systems #1770

Merged
merged 2 commits into from
Jul 31, 2023
Merged

Add information about using ratchetFrom on CI systems #1770

merged 2 commits into from
Jul 31, 2023

Conversation

magicus
Copy link
Contributor

@magicus magicus commented Jul 28, 2023

Add the important TL;DR from #710 to the documentation where it is pertinent.

I got almost crazy trying to figure out what was wrong. I understand now why ratchetFrom does not work on shallow clones, but as long as #710 is not fixed, this is critical information for anyone trying to setup a way of running Spotless with ratchetFrom on a CI system.

Add the important TL;DR from #710 to the documentation where it is pertinent.
@magicus
Copy link
Contributor Author

magicus commented Jul 28, 2023

Do you want to have an addition to CHANGES.md for pure documentation updates? I'll fix it, just let me know that it is indeed what you want.

@nedtwigg
Copy link
Member

Thanks for the input, no changelog entry needed. You okay with the condensed version I just pushed up?

@magicus
Copy link
Contributor Author

magicus commented Jul 30, 2023

Personally, I'd rather avoid linking to an issue (which might be edited on a whim by the reporter), and rather "hard code" the solution in place.

But then again, I don't mind much, as long as I can help someone avoid the struggle I had.

@nedtwigg
Copy link
Member

Thanks for the feedback. I prefer to link to the issue because it keeps the README easier, and makes it easier to keep up-to-date when new CI systems come to market.

@nedtwigg nedtwigg merged commit f66aaf5 into diffplug:main Jul 31, 2023
@magicus magicus deleted the patch-1 branch July 31, 2023 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants