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.

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

Add release documentation involving Github Actions #132

Merged
merged 3 commits into from Mar 4, 2019
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/development.rst
Expand Up @@ -230,6 +230,25 @@ there).

.. include:: ../CONTRIBUTING.rst


Creating a release
==================

OpenSCM uses designated Github Actions to upload the package to PyPI
(and, in the future, also to Conda). To create a release:

1. Change the "master" header in ``CHANGELOG.rst`` to the release
version number (not starting with "v", e.g. "1.2.3") and create a
new, empty "master" header above. Commit these changes with the
message, 'Prepare for release of vVERSIONNUMBER'' e.g. 'Prepare for
swillner marked this conversation as resolved.
Show resolved Hide resolved
release of v1.2.3'.
swillner marked this conversation as resolved.
Show resolved Hide resolved
2. Tag the commit as "vVERSIONNUMBER", e.g. "v1.2.3", on the "master"
branch. Push the tag.
3. The Github Actions workflow should now create a release with the
corresponding description in ``CHANGELOG.rst`` and upload the
release to PyPI.


.. _code_of_conduct:

.. include:: ../CODE_OF_CONDUCT.rst