Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release instructions after real experience #191

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update release instructions after real experience #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,17 @@ Post-merge instructions
Tagging the merge commit
------------------------

On your machine, check out the branch that tracks the official ``main`` branch
on the ``spacetelescope`` remote. Rebase it so it includes the newly merged pull
request. (If your local names for that branch or the ``spacetelescope`` remote
are different than the defaults – ``main`` and ``origin``, respectively – be
sure to substitute them in below.)

.. code-block:: text

git checkout origin main
git rebase origin/main

Apply a tag to the merge commit, substituting in the proper version number.

.. code-block:: text
Expand All @@ -58,9 +69,7 @@ Apply a tag to the merge commit, substituting in the proper version number.
and `adding it to your account <https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account>`_
if you don't have one.

Next, push the tag online. (If your remote that points to ``spacetelescope``'s
online version of the repository is not named ``origin``, be sure to substitute
its name in below.)
Push the tag online.

.. code-block:: text

Expand Down Expand Up @@ -131,7 +140,8 @@ Finally, upload them to PyPI:

.. code-block:: text

python setup.py sdist bdist_wheel
twine upload dist/*
# (Try "python -m twine upload dist/*" instead if twine is "not found.")

Note that PyPI uploads now require an API token.
`Refer to their instructions <https://pypi.org/help/#apitoken>`_ if you haven't
Expand Down
Loading