Skip to content

Commit 58fe392

Browse files
committed
Update README with documentation
1 parent 951963b commit 58fe392

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,33 @@ functionality of [`python-discord/bot`](https://github.com/python-discord/bot).
66
Built images contain a folder `/snekbin/` which contains the built Python
77
interpreter (with a binary at `/snekbin/bin/python`).
88

9+
## Adding new versions
910

11+
To add new versions to the build matrix, edit the `versions.toml` file to include
12+
the desired versions. The GitHub Actions workflow will automatically build and
13+
push the new versions when changes are merged to the main branch.
14+
15+
Additionally, new patch versions are automatically built as part of the cron job
16+
that runs daily. As long as pyenv is updated upstream with the new patch versions,
17+
they will be picked up and built without any manual intervention.
18+
19+
### Version Suffixes
20+
21+
Some Python versions have suffixes, these are specified as follows:
22+
23+
| Suffix | Meaning |
24+
| ------ | ------------------------------------- |
25+
| `j` | JIT enabled build (e.g., `3.11.0j`) |
26+
| `t` | Free-threaded build (e.g., `3.11.0t`) |
27+
28+
## GitHub Actions
29+
30+
A manual build can be triggered by going to the "Actions" tab and selecting the
31+
"Build Python Interpreters" workflow. From there, click the "Run workflow" button.
32+
33+
## Built Images
34+
35+
Built images are pushed to the GitHub Container Registry at
36+
[`ghcr.io/python-discord/python-builds`](ghcr.io/python-discord/python-builds). The
37+
images are tagged with the Python version they contain, e.g., `3.10.8` as well as the
38+
short tag, e.g., `3.10`.

0 commit comments

Comments
 (0)