Skip to content

Commit

Permalink
Document release process (#32)
Browse files Browse the repository at this point in the history
Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
  • Loading branch information
christophebedard authored Feb 5, 2024
1 parent 49bbce9 commit beabff6
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
18 changes: 18 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Developing colcon-lcov-result

## Developing

See [*Contributing* in the README](./README.rst#contributing).

## Releasing

1. Bump `__version__` in [`colcon_lcov_result/__init__.py`](./colcon_lcov_result/__init__.py)
1. Create commit with the new version number as the commit message
1. Tag that commit with the new version number
1. Push commit and tag
1. Package and publish using [dirk-thomas/publish-python](https://github.com/dirk-thomas/publish-python) (see instructions) to:
* PyPI: https://pypi.org/project/colcon-lcov-result/
* packagecloud: https://packagecloud.io/app/dirk-thomas/colcon/search?q=python3-colcon-lcov-result
1. Open a PR to bump version in [ros-infrastructure/reprepro-updater](https://github.com/ros-infrastructure/reprepro-updater) config files so that the ROS apt repos import packages from packagecloud
* For Debian: https://github.com/ros-infrastructure/reprepro-updater/blob/master/config/colcon.debian.upstream.yaml
* For Ubuntu: https://github.com/ros-infrastructure/reprepro-updater/blob/master/config/colcon.ubuntu.upstream.yaml
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,8 @@ Known Issues

#. The final step of aggregating all the result files can be slow depending
on the number of packages that were analyzed

Developing
==========

See `DEVELOPING.md <DEVELOPING.md>`_.

0 comments on commit beabff6

Please sign in to comment.