Skip to content

Commit 2d24fac

Browse files
authored
[ENH] Make release v0.1 (#84)
--------- Signed-off-by: Adam Li <[email protected]>
1 parent 881df16 commit 2d24fac

File tree

6 files changed

+455
-180
lines changed

6 files changed

+455
-180
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,35 @@ If you need to add new, or remove old dependencies, then you need to modify the
183183
poetry update
184184

185185
To update the lock file.
186+
187+
# Making a Release
188+
189+
0. Create a separate PR branch to make sure the whole process goes smoothly
190+
191+
git checkout main
192+
git pull --prune
193+
194+
# replace with your own version
195+
git checkout -b v0.1
196+
197+
1. Build package locally
198+
199+
poetry build
200+
201+
This will create a tar and wheel file in 'dist/'.
202+
203+
2. Upload package to test PyPi
204+
205+
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
206+
207+
Verify that installations work as expected on your machine.
208+
209+
3. Upload wheels
210+
211+
twine upload dist/*
212+
213+
4. Update `gh-pages` branch to account for the new version.
214+
215+
5. Create a tag on GH to make sure there is a commit associated with the new version.
216+
217+
6. Update version number on ``pyproject.toml`` file.

docs/whats_new.rst

+1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ on libraries.io to be notified when new versions are released.
1616
:maxdepth: 1
1717

1818
Version 0.1 <whats_new/v0.1.rst>
19+
Version 0.2 <whats_new/v0.2.rst>
1920

docs/whats_new/v0.1.rst

+1-4
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,11 @@ Here we list a changelog of pywhy-graphs.
1515

1616
.. currentmodule:: pywhy_graphs
1717

18-
.. _current:
18+
.. _0_1:
1919

2020
Version 0.1
2121
===========
2222

23-
**In Development**
24-
25-
2623
Changelog
2724
---------
2825
- |Feature| Add keyword argument for graph labels in :func:`pywhy_graphs.viz.draw`, by `Aryan Roy`_ (:pr:`71`)

docs/whats_new/v0.2.rst

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:orphan:
2+
3+
.. include:: _contributors.rst
4+
5+
.. _changes_0_2:
6+
7+
What's new?
8+
===========
9+
10+
Here we list a changelog of pywhy-graphs.
11+
12+
.. contents:: Contents
13+
:local:
14+
:depth: 3
15+
16+
.. currentmodule:: pywhy_graphs
17+
18+
.. _current:
19+
20+
Version 0.2
21+
===========
22+
23+
**In Development**
24+
25+
26+
Changelog
27+
---------
28+
-
29+
30+
Code and Documentation Contributors
31+
-----------------------------------
32+
33+
Thanks to everyone who has contributed to the maintenance and improvement of
34+
the project since version inception, including:
35+
36+
* `Adam Li`_
37+

0 commit comments

Comments
 (0)