-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Release
Here is the docsify release process.
- Create a release PR. New pull request
You can write the Changelog manually, such as #1524 Waiting for a review from @docsifyjs/reviewers
- Pull the latest changes
The develop and master branch should be up to date with the remote.
git clone [email protected]:docsifyjs/docsify.git
- Check whether you have npm access or not
If not, please contact @docsifyjs/reviewers
- Checkout the develop branch
The current default branch is develop, you can skip this step.
- Install dependencies
npm run bootstrap
- Run all tests
npm run test
-
Make sure the lib, theme folder and others are created and verify the numbers of files present in the lib theme and src
-
Run publish script
npm run pub
- it will ask for the version, give the version. such as:
4.12.0
- It will do the release. ed4b5be6
- It will also push the changes to the develop branch (verify this)
Note: Changelog and test snapshots may need to be updated(
npm run test:integration -- -u
) a2132c89, 8f3d8c9a
- Checkout the master branch
git checkout master
- Pull the changes from remote develop
git merge develop
- Push the changes to master
git push
- Release the version tag in GitHub
go to https://github.com/docsifyjs/docsify/releases
- Check the version of both docsify and docsify-server-renderer in npm
- Compare the develop and master branch in our github
there should not be any difference in the commit. both should be same.
-
Check the changelogs in both branches
-
The release PR (4.12.0) should be merged/closed automatically by now
if not then there is some problem.