Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/readthedocs/sphinx_rtd_theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Bach <benjamin@overtag.dk>2022-08-19 23:45:19 +0300
committerBenjamin Bach <benjamin@overtag.dk>2022-08-19 23:46:19 +0300
commit8e737d4c84f43849ae0b9701dc5a8f735ed2f4bd (patch)
tree72c1716357099686f88a05ff214cb9f0edc9b785
parente8440401010d146cbd32ade6184d19dc2d6241ba (diff)
Make note about releasing `package-lock.json`
-rw-r--r--docs/contributing.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index e95c771..f94bc46 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -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``.