ludwig-ai--ludwig
wehub-resource-sync
593b94c120
pytest / Unit Tests (push) Has been cancelled
pytest / Integration (integration_tests_a) (push) Has been cancelled
pytest / Integration (integration_tests_b) (push) Has been cancelled
pytest / Integration (integration_tests_c) (push) Has been cancelled
pytest / Integration (integration_tests_d) (push) Has been cancelled
pytest / Integration (integration_tests_e) (push) Has been cancelled
pytest / Integration (integration_tests_f) (push) Has been cancelled
pytest / Integration (integration_tests_g) (push) Has been cancelled
pytest / Integration (integration_tests_h) (push) Has been cancelled
pytest / Integration (integration_tests_i) (push) Has been cancelled
pytest / Integration (integration_tests_j) (push) Has been cancelled
pytest / Distributed (distributed_a) (push) Has been cancelled
pytest / Distributed (distributed_b) (push) Has been cancelled
pytest / Distributed (distributed_c) (push) Has been cancelled
pytest / Distributed (distributed_d) (push) Has been cancelled
pytest / Distributed (distributed_e) (push) Has been cancelled
pytest / Distributed (distributed_f) (push) Has been cancelled
pytest / Minimal Install (push) Has been cancelled
pytest / Event File (push) Has been cancelled
pytest (slow) / py-slow (push) Has been cancelled
Publish JSON Schema / publish-schema (push) Has been cancelled
51 行
1.9 KiB
Markdown
51 行
1.9 KiB
Markdown
# Releasing
|
|
|
|
## Release procedure
|
|
|
|
1. Update version number in `ludwig/globals.py`
|
|
1. Update the `README.md` file
|
|
1. Update `ludwig-docs`
|
|
1. Commit
|
|
1. Tag the commit with the version number `vX.Y.Z` with a meaningful message
|
|
1. Push with `--tags`
|
|
1. If a non-patch release, edit the release notes
|
|
1. The PyPI upload is automated via GitHub Actions (`.github/workflows/upload-pypi.yml`) when a release is published
|
|
1. Publish Docker images (see below)
|
|
|
|
## Docker images
|
|
|
|
Four images are published to Docker Hub under the `ludwigai` organisation for each release:
|
|
`ludwigai/ludwig`, `ludwigai/ludwig-gpu`, `ludwigai/ludwig-ray`, `ludwigai/ludwig-ray-gpu`.
|
|
|
|
### Automated (CI)
|
|
|
|
The GitHub Actions workflow `.github/workflows/docker.yml` triggers on `v*.*.*` tags and builds
|
|
images from the tagged source. If CI is healthy this runs automatically after step 6 above.
|
|
|
|
### Manual fallback
|
|
|
|
If CI does not run or images need to be backfilled, trigger a versioned build via the workflow
|
|
dispatch input — no local Docker setup required:
|
|
|
|
```bash
|
|
# Trigger all 4 image variants for a specific PyPI release
|
|
gh workflow run docker.yml --repo ludwig-ai/ludwig --ref main \
|
|
-f ludwig_version=0.14.0 -f latest=true
|
|
```
|
|
|
|
Or build and push locally using the script at `docker/build_and_push.sh`
|
|
(requires `docker login` to a `ludwigai` Docker Hub account):
|
|
|
|
```bash
|
|
./docker/build_and_push.sh 0.14.0 --latest
|
|
```
|
|
|
|
Both approaches install `ludwig[full]==<version>` from PyPI and produce two tags per image:
|
|
the full version (`0.14.0`) and the major.minor shorthand (`0.14`), plus `latest` when requested.
|
|
|
|
## Release policy
|
|
|
|
Ludwig follows [Semantic Versioning](https://semver.org).
|
|
In general, for major and minor releases, maintainers should all agree on the release.
|
|
For patches, in particular time sensitive ones, a single maintainer can release without a full consensus, but this practice should be reserved for critical situations.
|