ci(lint): reorganize workflows and add jobs to check readme diff #179
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
tthvo
added
feat
mwangggg
reviewed
Jul 18, 2024
mwangggg
reviewed
Jul 18, 2024
andrewazores
approved these changes
Jul 18, 2024
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.
Related to #73
Descriptions
Chore
Feature
Motivations
Currently, developers have to remember regenerating README + using the correct readme-generator tool and version. This new workflow can serve as a reminder and suggest hints on which command to run to update README.
Others
The latest version of readme-generator (
2.6.1) has some breaking changes, I believe. So, I am keeping it as2.5.x.Samples