Add inline docs on building API docs to commit block API verify error message #42432
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
getdave
added
Developer Experience
@gziolo fastest review ever! 😆 |
Although, on second thought. Should we recommend a more general command:
It might be three different things that changed the files represented as |
|
Size Change: 0 B Total Size: 1.25 MB ℹ️ View Unchanged
|
getdave
commented
Jul 14, 2022
| @@ -35,7 +35,7 @@ const getUnstagedReadmes = () => | |||
| '\n', | |||
| 'Some API docs may be out of date:', | |||
| unstagedReadmes.toString(), | |||
| 'Either stage them or continue with --no-verify.', | |||
| 'Either build and stage them with npm run api-docs:blocks or continue with --no-verify.', | |||
There was a problem hiding this comment.
Suggested change
| 'Either build and stage them with npm run api-docs:blocks or continue with --no-verify.', | |
| 'Either build and stage them with npm run docs:build or continue with --no-verify.', |
There was a problem hiding this comment.
@gziolo What do you think?
There was a problem hiding this comment.
It will always work correctly 👍🏻
|
I force merged this one because the failing e2e tests were unrelated. |
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.
What?
If you make a change to a block's attributes and then commit the pre-commit check will fail with the following message:
This PR adds instructions inline within the error message to include details on how to rebuild the API docs.
Closes #42420
Why?
Because it's easier if the error tells you how to fix it.
How?
Adds instructions to error.
Testing Instructions
block.jsonnpm run api-docs:blocks.Screenshots or screencast