Adding bits for first release

massrobotics_amr_sender_py/README.md

@@ -13,9 +13,9 @@ git clone https://github.com/inorbit-ai/ros_amr_interop.git ./src
 colcon build --packages-select massrobotics_amr_sender
 ```
 
-## Running the node
+## Running the node from source
 
-The node takes the Mass AMR config file path as parameter. If not provided, it is assumed the file is on the current directory.
+The node takes the MassRobotics AMR config file path as parameter. If not provided, it is assumed the file is on the current directory.
 
 ```bash
 # Source the local overlay by running `. install/setup.sh` if
@@ -33,3 +33,27 @@ On you local workspace:
 colcon test --packages-select massrobotics_amr_sender
 colcon test-result --verbose
 ```
+
+## Releasing a new version
+
+This is a summary of the steps required for releasing a new package.
+
+1. Run ``catkin_generate_changelog`` to generate or update CHANGELOG.rst file(s)
+
+    ```bash
+    # Change directory to repository root folder
+    $ cd ../
+    $ catkin_generate_changelog
+    Found packages: massrobotics_amr_sender
+    Querying commit information since latest tag...
+    Updating forthcoming section of changelog files...
+    - updating 'massrobotics_amr_sender_py/CHANGELOG.rst'
+    Done.
+    Please review the extracted commit messages and consolidate the changelog entries before committing the files!
+    ```
+
+2. Open ``CHANGELOG.rst`` and edit to your liking. Then commit your new/updated changelog.
+
+3. Run ``catkin_prepare_release`` for bumping up package version. By default this command increases the patch version of your package, e.g. ``0.1.1 -> 0.1.2``, but you can pick minor or major using the ``--bump`` option.
+
+    **Note**: this command increment the version in your ``package.xml``'s, and commit/tag the changes with a bloom compatible flag.

massrobotics_amr_sender_py/setup.py

@@ -1,4 +1,8 @@
 from setuptools import setup, find_packages
+import xml.etree.ElementTree as ET
+
+# Read version from ``package.xml`` file
+package_xml = ET.parse('package.xml').getroot()
 
 package_name = 'massrobotics_amr_sender'
 
@@ -7,7 +11,7 @@
     packages=find_packages(),
     package_data={'': ['schema.json']},
     include_package_data=True,
-    version='0.0.2',
+    version=package_xml.find('version').text,
     data_files=[
         ('share/ament_index/resource_index/packages',
             ['resource/' + package_name]),

workspace.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "massrobotics_amr_sender_py"
+		}
+	],
+	"settings": {}
+}