fmi-chroma

This repo is used to create a docker image with Chroma database of FMI related docs.

• Github repository: https://github.com/iakovn/fmi-chroma/
• Documentation https://iakovn.github.io/fmi-chroma/

Development

1. Setup devenv

The devenv utilized devcontainer, i.e., you need to have podman or docker install. It's based on template: https://github.com/fpgmaas/cookiecutter-uv.git Follow the steps below in the running container.

2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

make install

This will also (re)generate your uv.lock file

3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

uv run pre-commit run -a

4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

git add .
git commit -m 'Fix formatting issues'
git push origin main

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on PyPI.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

---

Repository initiated with fpgmaas/cookiecutter-uv.