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

Added to release guide #181

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

Added to release guide #181

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
14 changes: 10 additions & 4 deletions docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ manually create a new release in the ``spacetelescope/STScI-STIPS`` GitHub repos
#. Press the "Draft a new release" button above the list of releases.
#. Press "Choose a tag" and select the one you just pushed online. The target branch should already be selected as ``main``.
#. Press "Generate release notes" to list the commits included in this release.
#. In the "Release title" textbox, type ``Release X.Y.Z``, substituting in the proper version number.
#. In the "Release title" textbox, type ``STIPS Version X.Y.Z``, substituting in the proper version number.
#. Above the list of commits in the larger textbox for comments, write a single-sentence summary of the release's major updates.
#. Press "Publish" to complete this section.

Expand Down Expand Up @@ -130,7 +130,7 @@ Finally, upload them to PyPI:

.. code-block:: text

python setup.py sdist bdist_wheel
python -m twine upload dist/*

Note that PyPI uploads now require an API token.
`Refer to their instructions <https://pypi.org/help/#apitoken>`_ if you haven't
Expand All @@ -151,8 +151,14 @@ commit will be the repository's current latest commit, so both versions should
be identical for the moment.

The versions of the documentation that should be visible to the public and
marked as "Active" on their "Edit" pages are ``latest`` and the new release,
``vX.Y.Z``. In the future, we may make past versions visible, too.
marked as "Active" on their "Edit" pages are ``main``, ``latest``, and the new
release, ``vX.Y.Z``. On `the "Versions" page <https://readthedocs.org/projects/stips/versions/>`_,
press "Edit" beside any other publicly visible versions and select the "Hidden"
checkbox for them. In the future, we may make past versions visible, too.

Finally, go to the "Admin" tab, make sure you're in the "Settings" section, and
change the "Default branch" to the new ``vX.Y.Z``. (Note that this is different
from the "Default version" setting further down the page, which should be ``latest``.)

Troubleshooting: webhooks
-------------------------
Expand Down
Loading