docs(no-story): prevent merge conflicts when generating docs for old branches #3864
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.
Description
What is changing?
When we generate docs for an old branch (5.x for example), we get merge conflicts because the release files in our static docs site are out-of-sync with main.
Our docs build script already reads these files in, updates the contents and writes them back out. We can prevent merge conflicts by first updating the files on the target branch (5.x for example) with the contents from main. Then, when we generate the docs we update the contents of the files already accounting for changes on main.
Hypothetical example: docs generation for a new minor, 5.19 (random version number > our existing latest 5.x)
Current workflow:
Proposed workflow:
Is there new documentation needed for these changes?
What is the motivation for this change?
Release Highlight
Fill in title or leave empty for no highlight
Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript