python-rope / rope

a python refactoring library
GNU Lesser General Public License v3.0
1.95k stars 163 forks source link

Document build and release process #388

Closed lieryan closed 3 years ago

lieryan commented 3 years ago

Later down the road we want to be able to automate releases, but for now, let's document the existing process first.

lieryan commented 3 years ago

Hi @mcepl, can I please request your assistance here with documenting the release process here.

Do you want to continue managing releases in the long term or would you like to handover this task as well?

mcepl commented 3 years ago

I want to complete disentangle myself from rope, so I may try to be around from a while to help with the transition, but less I do happier I am.

Concerning the release process, there is not much to be said:

  1. Increase the number in rope/__init__.py
  2. Tag the release with the tag annotation containing the release information
  3. python3 setup.py sdist
  4. twine upload -s dist/rope-$VERSION.tar.gz*
lieryan commented 3 years ago

Thanks for clarifying your intent. I think the next step in the transition is for me to set up and gain the credentials so I would be able to upload a new release to PyPI.

Would you be able to add my PyPI account (lieryan) so I would be able to upload new releases for rope-related projects in PyPI?

And thank you again for all the years you've been maintaining rope.

mcepl commented 3 years ago

Done

lieryan commented 3 years ago

Thanks!

lieryan commented 3 years ago

Basic release process documentation now added in https://github.com/python-rope/rope/blob/620ff09bdd38777fb42460cec5514a861bb426f9/docs/release-process.rst