Skip to content

Commit

Permalink
[ENH] Make release v0.1 (#84)
Browse files Browse the repository at this point in the history
---------

Signed-off-by: Adam Li <adam2392@gmail.com>
  • Loading branch information
adam2392 authored Jul 6, 2023
1 parent 881df16 commit 2d24fac
Show file tree
Hide file tree
Showing 6 changed files with 455 additions and 180 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,35 @@ If you need to add new, or remove old dependencies, then you need to modify the
poetry update

To update the lock file.

# Making a Release

0. Create a separate PR branch to make sure the whole process goes smoothly

git checkout main
git pull --prune

# replace with your own version
git checkout -b v0.1

1. Build package locally

poetry build

This will create a tar and wheel file in 'dist/'.

2. Upload package to test PyPi

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Verify that installations work as expected on your machine.

3. Upload wheels

twine upload dist/*

4. Update `gh-pages` branch to account for the new version.

5. Create a tag on GH to make sure there is a commit associated with the new version.

6. Update version number on ``pyproject.toml`` file.
1 change: 1 addition & 0 deletions docs/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ on libraries.io to be notified when new versions are released.
:maxdepth: 1

Version 0.1 <whats_new/v0.1.rst>
Version 0.2 <whats_new/v0.2.rst>

5 changes: 1 addition & 4 deletions docs/whats_new/v0.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,11 @@ Here we list a changelog of pywhy-graphs.

.. currentmodule:: pywhy_graphs

.. _current:
.. _0_1:

Version 0.1
===========

**In Development**


Changelog
---------
- |Feature| Add keyword argument for graph labels in :func:`pywhy_graphs.viz.draw`, by `Aryan Roy`_ (:pr:`71`)
Expand Down
37 changes: 37 additions & 0 deletions docs/whats_new/v0.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:orphan:

.. include:: _contributors.rst

.. _changes_0_2:

What's new?
===========

Here we list a changelog of pywhy-graphs.

.. contents:: Contents
:local:
:depth: 3

.. currentmodule:: pywhy_graphs

.. _current:

Version 0.2
===========

**In Development**


Changelog
---------
-

Code and Documentation Contributors
-----------------------------------

Thanks to everyone who has contributed to the maintenance and improvement of
the project since version inception, including:

* `Adam Li`_

Loading

0 comments on commit 2d24fac

Please sign in to comment.