From 879c380105e8a6a061dd20dc731479adebba80b3 Mon Sep 17 00:00:00 2001 From: Adam Li Date: Wed, 6 Dec 2023 12:37:53 -0500 Subject: [PATCH] Add temp release process Signed-off-by: Adam Li --- CONTRIBUTING.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82149cb3..b01657a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,4 +67,39 @@ Some good tools for profiling memory are ``mprof``. For example, one can memory Then one could plot the memory usage: - mprof plot \ No newline at end of file + mprof plot + +# Making a Release + +1. Ctrl+f and replace all version indicators with the new version. For example, + +`0.5.0dev0` -> `0.5.0` + +2. Write release notes in `whats_new.rst` + +3. Build package locally and test + + + python -m build + +4. Upload to Test PyPi + + + twine upload --repository-url https://test.pypi.org/legacy/ dist/* + + +5. Build docs locally + + make -C build-doc + +6. Push docs under `doc/_build/html/` to the `stable/` folder in `gh-pages` branch + + +7. Make release to PyPi + + + twine upload dist/* + +or if you have two-factor authentication enabled: + + twine upload dist/* --repository mne-connectivity