paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 04:23:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a028fb710b9c56cf55ecad635eb0c5142f22ed1a
zulip/docs/subsystems/api-release-checklist.md
David Rosa Tamsen 7072fa5b37 docs: Reorganize developer docs to improve navigation. 
This commit helps reduce clutter on the navigation sidebar.
Creates new directories and moves relevant files into them.
Modifies index.rst, symlinks, and image paths accordingly.

This commit also enables expandable/collapsible navigation items,
renames files in docs/development and docs/production,
modifies /tools/test-documentation so that it overrides a theme setting,
Also updates links to other docs, file paths in the codebase that point
to developer documents, and files that should be excluded from lint tests.

Note that this commit does not update direct links to
zulip.readthedocs.io in the codebase; those will be resolved in an
upcoming follow-up commit (it'll be easier to verify all the links
once this is merged and ReadTheDocs is updated).

Fixes #5265.
2017-11-16 09:45:08 -08:00

1.6 KiB
Raw Blame History

Zulip PyPI package release checklist

This document describes the steps to be followed when preparing a new release of the PyPI package for our API bindings.

While performing the steps outlined below, we should adhere to the guidelines presented in the Python Packaging User Guide.

The steps below assume that you are familiar with the material presented here.

  1. Reconfigure the package, if need be (upgrade version number, development status, and so on).

  2. Create a source distribution.

  3. Create a pure Python Wheel.

  4. Upload the distribution file(s) to zulip-beta.

  5. Post about the beta release in #general and test the zulip-beta package extensively.

  6. Respond to the feedback received in Step 5.

  7. Make final changes, upload the distribution file(s) to the main zulip package.

  8. Post in #general about the new release.

Note: We may upload directly to the main zulip package without beta-testing on zulip-beta, if we feel that the changes made in the new release are minor and not disruptive enough to warrant extensive pretesting.