build: Run readme generation in build #18198
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
github-actions
bot
added
area: examples
Josmithr
reviewed
Nov 7, 2023
| @@ -27,6 +27,7 @@ | |||
| "build:gendocs:client:packages": "copyfiles \"packages/**/*.api.json\" ./_api-extractor-temp/doc-models/ -e \"**/node_modules/**\" -f -V", | |||
| "build:gendocs:server": "concurrently \"npm:build:gendocs:server:*\"", | |||
| "build:gendocs:server:routerlicious": "copyfiles \"server/routerlicious/**/*.api.json\" ./_api-extractor-temp/doc-models/ -e \"**/node_modules/**\" -f -V", | |||
| "build:readme": "markdown-magic --files \"**/*.md\" !docs", | |||
There was a problem hiding this comment.
Should we remove this step from the docs build now that we have it here?
There was a problem hiding this comment.
I thought about that, but since the docs build imports stuff from elsewhere in the repo, seemed good to leave it as a step in the "docs build."
Josmithr
approved these changes
Nov 7, 2023
tylerbutler
added a commit
that referenced
this pull request
Nov 10, 2023
PR #18198 added a dependency to the root that caused a peer dependency warning. The dep is not needed at the root, so I added it to the peer dep overrides.
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.
The scripts and tools we use to generate readme contents in the repo has never been run as part of the main build. This PR adds a step to the build,
build:readmewhich calls markdown-magic to regen the readmes across the repo, excluding the docs folder.There are similar scripts in the docs package. Those don't need to be modified; they're just a little unnecessary now.
I also updated the repo-wide policy CI workflow (the one that runs on every PR) to no longer run the root prettier script (it's now part of the build) and runs build:readme instead. This will catch any changes outside the client release group, since md-magic runs repo-wide.