[chore] Improve release script by automating documentation update #10575
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.
Problem
There are still too many manual steps when releasing a new react-admin version.
Solution
Follow #10574
Automate one more step: updating the documentation automatically when possible:
react-admin-doc
sibling directory if it existsreact-admin-doc/_data/versions.yml
react-admin-doc/_data/versions.yml
You can override the documentation directory path by setting the
RA_DOC_PATH
environment variable.How To Test
These scripts support a
RELEASE_DRY_RUN
env variable allowing to skip all mutations to git, GitHub or npm, except 1 git commit (but not pushed!) from lerna.First, create a
.env
file from the.env.template
file and fill it in with your Github token.Then run:
When this is done, don't forget to revert the commit created by lerna to update the versions:
Additional Checks
master
for a bugfix, ornext
for a feature