Skip to content

Commit

Permalink
Add documentation on how to make a release
Browse files Browse the repository at this point in the history
References #10
  • Loading branch information
cthoyt committed Dec 19, 2020
1 parent 15acda8 commit 89f79bc
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,25 @@ calculations requires binning the data to produce discrete distributions.
With the various methods for sampling conditional, interventional, and counterfactual distributions from the model, the
SCM can estimate the Controlled Direct Effect (example.cd_effect), the Natural Direct Effect (example.nd_effect), and
the Natural Indirect Effect (example.ni_effect). Finally, the SCM can write itself to a json file that can then be
imported directly to Causal Fusion (example.write_to_cf).
imported directly to Causal Fusion (example.write_to_cf).

## Making a Release

After installing the package in development mode and installing
`tox` with `pip install tox`, the commands for making a new release are contained within the `finish` environment
in `tox.ini`. Run the following from the shell:

```bash
$ tox -e finish
```

This script does the following:

1. Uses BumpVersion to switch the version number in the `setup.cfg` and
`src/bel2scm/version.py` to not have the `-dev` suffix
2. Packages the code in both a tar archive and a wheel
3. Uploads to PyPI using `twine`. Be sure to have a `.pypirc` file configured to avoid the need for manual input at this
step
4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use `tox -e bumpversion minor` after.

0 comments on commit 89f79bc

Please sign in to comment.