Release

Here is the docsify release process.

Steps

1. Create a release PR. New pull request

Note

You can write the Changelog manually, such as #1524
Waiting for a review from @docsifyjs/reviewers

2. Pull the latest changes

Note

Your local develop and main branches should be up to date with the remote.

git clone git@github.com:docsifyjs/docsify.git

3. Check whether you have npm access or not

Note

If not, please contact @docsifyjs/reviewers

4. Checkout the develop branch

Note

The current default branch is develop, you can skip this step.

5. Install dependencies

npm i 

6. Run all tests

npm test

7. Make sure the lib, theme folder and others are created and verify the numbers of files present in the lib theme and src

8. Run publish script

Important

You should ensure you are logged into npmjs. You can check this by running npm whoami.

npm run pub

• it will ask for the version, give the version. such as: 4.12.0
• It will do the release. F.e. ed4b5be6
• It will also push the changes to the develop branch (verify this)

Note

The changelog may need to be updated. If there are changes, remember to describe them. F.e. a2132c89

Note

Do not update snapshots during this time. Snapshot updates must be reviewed and approved via the regular pull request process to ensure we're not snapshotting bugs.

9. Checkout the main branch

git checkout main

10. Pull the changes from remote develop

git merge develop

11. Push the changes to main

git push

12. Release the version tag to GitHub

Go to https://github.com/docsifyjs/docsify/releases

Verify

1. Check the version of both docsify and docsify-server-renderer in npm

• docsify - docsify-server-renderer

2. Compare the develop and main branches in our github

Note

there should not be any differences in commits; both should be same.

3. Check the changelogs in both branches

4. The release PR (4.12.0) should be merged/closed automatically by now

Note

if not then there is some problem.