From 5e8ba84fa4c10ecee28cab15791062ae52862f4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Courty?= <6603048+benoit-cty@users.noreply.github.com> Date: Sun, 17 May 2026 15:40:40 +0200 Subject: [PATCH] How to test the release --- docs/how-to/contributing.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/how-to/contributing.md b/docs/how-to/contributing.md index 8a65bb57b..3d192a9c1 100644 --- a/docs/how-to/contributing.md +++ b/docs/how-to/contributing.md @@ -323,6 +323,26 @@ git push --force-with-lease - [Edit the Draft release](https://github.com/mlco2/codecarbon/releases/) on Github and give it a tag, `v1.0.0` for the version 1.0.0. Github will automatically create a Git tag for it. Complete help [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). - A [Github Action](https://github.com/mlco2/codecarbon/actions) _Upload Python Package_ will be run automaticaly to upload the package. +#### Test the release + +After the release on PyPi, please test it in a fresh environment: + +```sh +cd /tmp +rm -rf cc_rel_test +python -m venv cc_rel_test +source cc_rel_test/bin/activate +pip install codecarbon +# Check you have the last version +codecarbon --version +codecarbon monitor --offline --country-iso-code FRA +# Stop it with Ctrl+C if it works +# Then clean up +rm -rf cc_rel_test +``` + +And check if the doc looks good on [docs.codecarbon.io](https://docs.codecarbon.io/). + #### Test the build in Docker