Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Improve release script by automating documentation update #10575

Merged
merged 5 commits into from
Mar 7, 2025

Conversation

djhi
Copy link
Collaborator

@djhi djhi commented Mar 7, 2025

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:

  • Copy the new doc to the react-admin-doc sibling directory if it exists
  • Update the latest version in react-admin-doc/_data/versions.yml
  • Add a new minor entry if necessary in 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:

RELEASE_DRY_RUN=true make release

When this is done, don't forget to revert the commit created by lerna to update the versions:

git reset --hard HEAD~1

Additional Checks

  • The PR targets master for a bugfix, or next for a feature

@slax57 slax57 merged commit fd7599f into master Mar 7, 2025
16 checks passed
@slax57 slax57 deleted the improve-release-script-documentation branch March 7, 2025 14:17
@slax57 slax57 added this to the 5.6.3 milestone Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants