Skip to content

Commit 97f8dbf

Browse files
committed
chore: added publish notes
1 parent 90a8652 commit 97f8dbf

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/02-development.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,23 @@ This repository is self-contained and relies heavily on `uv` for dependency mana
1313
* `make publish-test` - requires setting an external token with `export UV_PUBLISH_TOKEN=pypi-abc...` and uploads to pypi's test
1414
* `make publish` - requires setting an external token with `export UV_PUBLISH_TOKEN=pypi-def...` and uploads to the official pypi index
1515

16-
Before running the `make publish*` targets, make sure to set the correct token depending on which index you are uploading to.
1716

17+
## Publishing Explained
18+
19+
There are two places one can publish python packages to: PyPi and TestPyPi. The Test- one serves only the purpose to help maintainers test a package out before they publish it to the official one. Due to Python's dynamic typing, sometimes it is only possible to test things by running them, so we recommend doing this. When publishing to the TestPyPi you must use the following command to install.
20+
21+
``` bash
22+
# Fetches the latest 'roverlib' package from TestPyPi
23+
# Make sure to remove any installation of roverlib before proceeding.
24+
python3 -m pip install --index-url https://test.pypi.org/simple/ roverlib
25+
```
26+
27+
As explained earlier, you must get a token form the maintainer handbook for the registry to which you want to publish to. For example, to publish to PyPi:
28+
29+
``` bash
30+
export UV_PUBLISH_TOKEN=pypi-123abc456def
31+
make publish
32+
```
1833

1934
# What to do when the bootspec updates
2035

0 commit comments

Comments
 (0)