Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

83 lines (58 loc) · 2.15 KB

Contributing to frequenz-sdk

Build

You can use build to simply build the source and binary distribution:

python -m pip install build
python -m build

Local development

You can use editable installs to develop the project locally (it will install all the dependencies too):

python -m pip install -e .

You can also use nox to run the tests and other checks:

python -m pip install nox
nox

You can also use nox -R to reuse the current testing environment to speed up test at the expense of a higher chance to end up with a dirty test environment.

Running tests individually

For a better development test cycle you can install the runtime and test dependencies and run pytest manually.

python -m pip install .
python -m pip install pytest pytest-asyncio

# And for example
pytest tests/test_sdk.py

Releasing

These are the steps to create a new release:

  1. Get the latest head you want to create a release from.

  2. Update the RELEASE_NOTES.md file if it is not complete, up to date, and clean from template comments (<!-- ... ->) and empty sections. Submit a pull request if an update is needed, wait until it is merged, and update the latest head you want to create a release from to get the new merged pull request.

  3. Create a new signed tag using the release notes and a semver compatible version number with a v prefix, for example:

    git tag -s -F RELEASE_NOTES.md v0.0.1

  4. Push the new tag.

  5. A GitHub action will test the tag and if all goes well it will create a GitHub Release, create a new announcement about the release, and upload a new package to PyPI automatically.

  6. Once this is done, reset the RELEASE_NOTES.md with the template:

    cp .github/RELEASE_NOTES.template.md RELEASE_NOTES.md

    Commit the new release notes and create a PR (this step should be automated eventually too).

  7. Celebrate!