DEVELOPING.md

Developer guide

This is a guide for developing on this repository and this library. For instructions on how to use signalfx-python, please refer to the README.rst file.

Updating protobuf definitions

This library uses generated code from the SignalFx protobuf definitions. To update as necessary, from the root project directory run:

$ scripts/genproto.sh

And commit the updated signal_fx_protocol_buffers_pb2.py after vetting the live tests with tox.

Making a release

1. Figure out the next release version number (X.Y.Z) and update signalfx/version.py
2. Update the CHANGELOG.md file with information about the new release
3. Confirm the build and tests pass:

   tox
   

4. Commit and tag the release as vX.Y.Z:

   git add signalfx/version.py CHANGELOG.md
   git commit -m "Version X.Y.Z"
   git tag -s -m "Version X.Y.Z" vX.Y.Z HEAD
   

5. Build the release:

   python setup.py sdist bdist_wheel
   

6. Upload the release:

   twine upload dist/signalfx-X.Y.Z*