Rework gen-readme #511
Merged
Rework gen-readme #511
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
eps1lon
force-pushed
the
fix/494-remove-duplicated-section-
branch
3 times, most recently
from
c5b8889 to
e382132
Compare
eps1lon
force-pushed
the
fix/494-remove-duplicated-section-
branch
from
87a758f to
4d5a46f
Compare
filiptammergard
approved these changes
Jun 6, 2022
|
btw you two are pretty much the most active maintainers right now - feel free to take the inactive names off the readme for those getting credit and get filip on |
Closed
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.
While working on #494 I noticed that testing gen-readme has quite the roundtrip time since you need to push and merge to see effects.
Instead, the script now simply updates the contents of README.md locally and CI ensures these changes are committed.
Example failure: https://github.com/typescript-cheatsheets/react/runs/6738164939?check_suite_focus=true
This way we can easily test changes locally and changes to README are now always associated with the underlying change to docs/.
The flipside is that this step now has to be done manually. Automatically committing these changes in a PR is annoying since this would mean you collaborate with a bot on a branch which has its own sets of problems (branch out-of-date, push conflicts, surprise changes etc).