Skip to content

Commit 7000cd4

Browse files
authored
How to test the release (#1198)
1 parent 08dcc1b commit 7000cd4

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/how-to/contributing.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,26 @@ git push --force-with-lease
323323
- [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).
324324
- A [Github Action](https://github.com/mlco2/codecarbon/actions) _Upload Python Package_ will be run automaticaly to upload the package.
325325

326+
#### Test the release
327+
328+
After the release on PyPi, please test it in a fresh environment:
329+
330+
```sh
331+
cd /tmp
332+
rm -rf cc_rel_test
333+
python -m venv cc_rel_test
334+
source cc_rel_test/bin/activate
335+
pip install codecarbon
336+
# Check you have the last version
337+
codecarbon --version
338+
codecarbon monitor --offline --country-iso-code FRA
339+
# Stop it with Ctrl+C if it works
340+
# Then clean up
341+
rm -rf cc_rel_test
342+
```
343+
344+
And check if the doc looks good on [docs.codecarbon.io](https://docs.codecarbon.io/).
345+
326346
<!-- TOC --><a name="test-the-build-in-docker"></a>
327347
#### Test the build in Docker
328348

0 commit comments

Comments
 (0)