develop.rst 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. Development
  2. -----------
  3. Generally crocoite provides reasonable defaults for Google Chrome via
  4. :py:mod:`crocoite.devtools`. When debugging this software it might be necessary
  5. to open a non-headless instance of the browser by running
  6. .. code:: bash
  7. google-chrome-stable --remote-debugging-port=9222 --auto-open-devtools-for-tabs
  8. and then passing the option :option:`--browser=http://localhost:9222` to
  9. :program:`crocoite-single`. This allows human intervention through the
  10. browser’s builtin console.
  11. Release guide
  12. ^^^^^^^^^^^^^
  13. crocoite uses `semantic versioning`_. To create a new release, bump the version
  14. number in ``setup.py`` according to the linked guide, create distribution
  15. packages::
  16. python setup.py sdist bdist_wheel
  17. Verify them::
  18. twine check dist/*
  19. Try to install and use them in a separate sandbox. And finally sign and upload
  20. a new version to pypi_::
  21. gpg --detach-sign --armor dist/*.tar.gz
  22. twine upload dist/*
  23. Then update the documentation using :program:`sphing-doc` and upload it as well.
  24. .. _semantic versioning: https://semver.org/spec/v2.0.0.html
  25. .. _pypi: https://pypi.org