Skip to content

Commit 3a4cc62

Browse files
committed
remove new release info
1 parent 4a12f93 commit 3a4cc62

File tree

1 file changed

+0
-34
lines changed

1 file changed

+0
-34
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -81,41 +81,7 @@ The `.readthedocs.yaml` file contains the configurations for the remote build.
8181

8282
If there are autodoc issues/errors in remote builds of the docs, we need to add all package dependencies (in `requirements.txt`) into the list `autodoc_mock_imports` in `docs/config.py`.
8383

84-
## New releases
8584

86-
### Test release to `test.pypi.org` (manual)
87-
88-
1. Bump the release version in `causalpy/version.py` and `pyproject.toml`.
89-
2. Build locally and upload to test.pypi.org. Full instructions here https://packaging.python.org/en/latest/tutorials/packaging-projects/. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
90-
```bash
91-
rm -rf dist
92-
python3 -m build
93-
python3 -m twine upload --repository testpypi dist/*
94-
```
95-
3. At this point the updated build is available on test.pypi.org. We can test that this is working as expected by installing (into a test environment) from test.pypi.org with
96-
97-
```bash
98-
conda create -n causalpy-test python
99-
conda activate causalpy-test
100-
python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ causalpy
101-
```
102-
103-
4. Now load a python or ipython session and follow the quickstart instructions to confirm things work.
104-
105-
### Actual release to `pypi.org` (manual)
106-
107-
1. Bump the release version in `causalpy/version.py` and `pyproject.toml` (if not done in the previous step). This is automatically read by `setup.py` and `docs/config.py`.
108-
2. Push this to a branch, open a pull request, and merge into main.
109-
3. Manually draft a new release [here](https://github.com/pymc-labs/CausalPy/releases), making sure to hit 'generate release notes'.
110-
4. Build locally and upload to pypi.org. In the root directory:
111-
```bash
112-
rm -rf dist
113-
python3 -m build
114-
python3 -m twine upload dist/*
115-
```
116-
5. Readthedocs:
117-
- Docs should be built remotely every time there is a pull request
118-
- See here https://docs.readthedocs.io/en/stable/tutorial/#versioning-documentation for versioning the docs
11985

12086
## Overview of code structure
12187

0 commit comments

Comments
 (0)