build: generate README #580
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
Codecov ReportBase: 98.62% // Head: 98.62% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #580 +/- ##
=======================================
Coverage 98.62% 98.62%
=======================================
Files 58 58
Lines 1386 1386
Branches 221 221
=======================================
Hits 1367 1367
Misses 12 12
Partials 7 7
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
ROpdebee
force-pushed
the
generate-readme
branch
from
ede1eac to
9808d4a
Compare
ROpdebee
force-pushed
the
generate-readme
branch
from
9808d4a to
0f8036d
Compare
Owner
Author
|
/deploy-preview |
|
This PR makes no changes to the built userscripts. |
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.
Instead of manually updating the information in the README, which can be cumbersome with all of the links, let's use a script to generate it automatically. It also supports the legacy JS scripts, so that should make it easier to do the TS migration for each script individually without needing to spend time changing the README.
I've also added a check to the build process so that the build (and by extension, CI) will fail if the README becomes outdated.