[Build Tooling]: Fix pre commit hook to build block docs #37613
Merged
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
ntsekouras
added
[Type] Build Tooling
ntsekouras
requested review from
mkaz,
ockham,
mcsf,
Mamaduka,
aristath and
gziolo
ntsekouras
requested review from
ajitbohra,
nerrad,
ntwb and
oandregal
as code owners
|
Size Change: 0 B Total Size: 1.13 MB ℹ️ View Unchanged
|
ntsekouras
force-pushed
the
fix/lint-staged-api-docs
branch
from
40940c7 to
08237e4
Compare
gziolo
approved these changes
Dec 23, 2021
Mamaduka
approved these changes
Dec 23, 2021
mcsf
approved these changes
Dec 23, 2021
|
Thanks @ntsekouras for fixing, looks good. I thought I had it tested and working but 🤷♂️ |
mkaz
added a commit
that referenced
this pull request
Dec 24, 2021
Update lint-staged to command to run script to generate theme.json reference prior to checking for changed files. For details fixing similar issue see PR #37613
mkaz
added a commit
that referenced
this pull request
Jan 4, 2022
* Initial script to generate settings and style for theme.json * Add to table of contents and link to how to guide - Adds a brief paragraph at top of reference guide linking to how to guide for examples - Adds reference guide to table of contents / manifest * Add markdownDescription for appearanceTools To enrich the automated docs this adds a markdownDescription field for appearanceTools to explain what tools are enabled. You can see the markdownDescription field used in the tsconfig schema here: http://json.schemastore.org/tsconfig * Add support for markdownDescription in generated docs * Update generated docs. * Dont use markdownDescription yet, move rich description to description field. * Remove markdownDescription field * Change doc scripts trigger for pre-commit Update lint-staged to command to run script to generate theme.json reference prior to checking for changed files. For details fixing similar issue see PR #37613
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.
I don't know if it's just me and is specific to some environment params but I can't commit anything. The error is something like that:
What happens here is that we have a pre commit hook that runs npm-run-all api-docs:* but
lint-stagedpasses full paths to staged changes so in combination with thenpm-run-all, we end up trying to match ataskfrom eachstaged file.In this PR I removed the
npm-run-allcommand to avoid the above issue and also changed theTOKENfor core blocks documentation in order to be notified by theare-api-docs-unstaged.jshere, which is run right afterwards.Testing instructions
block.json- let's say add an attribute and observe that it will not let you because of the updated docs