Maintaining the Codebase¶
Ibis maintainers are expected to handle the following tasks as they arise:
- Reviewing and merging pull requests
- Triaging new issues
A number of tasks that are typically associated with maintenance are partially or fully automated.
- WhiteSource Renovate (Python library dependencies and GitHub Actions)
- Custom GitHub Action (Nix dependencies)
Occasionally you may need to lock
poetry dependencies. Edit
pyproject.toml as needed, then run:
poetry lock --no-update
If you're not a maintainer, please open an issue asking us to add your example.
You need the ability to write to the
gs://ibis-examples GCS bucket to add an example.
Make sure you're in the root of the ibis git repository.
Assuming your file is called
- Add a gzip-compressed CSV file with the path
- Add a file named
ibis/examples/descriptions/examplethat contains a description of your example. One line is best, but not necessary.
- Run one of the following from the git root of an ibis clone:
python ibis/examples/gen_registry.py(doesn't include R dependenices)
nix run '.#gen-examples'(includes R dependenices)
Ibis is released on PyPI and Conda Forge.
Releases to PyPI are handled automatically using semantic release.
To trigger a release use the Release GitHub Action.
The conda-forge package is maintained as a conda-forge feedstock.
After a release to PyPI, the conda-forge bot automatically updates the ibis package.