Skip to content

Commit

Permalink
Make note about releasing package-lock.json
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaoming committed Aug 19, 2022
1 parent e844040 commit 8e737d4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,8 @@ To release a new version of the theme, core team will take the following steps:
#. Run ``npm install && npm run build && python setup.py bdist_wheel sdist`` to rebuild all the theme assets and the Python
package, notice that ``package-lock.json`` will be updated with a new package
version. But take care that it isn't also bumping versions of dependencies
in ways that are risky to the release.
in ways that are risky to the release. *If* ``package-lock.json`` changes, you
need to commit it to git and tag it together with your release.
#. Commit these changes.
#. Tag the release in git: ``git tag $NEW_VERSION``.
#. Push the tag to GitHub: ``git push --tags origin``.
Expand Down

0 comments on commit 8e737d4

Please sign in to comment.