-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding bits for first release #7
Adding bits for first release #7
Conversation
@adamantivm @miguelgarcia Ready for review. I added some minor changes and did some tests on the tooling needed for first time release: http://wiki.ros.org/bloom/Tutorials/FirstTimeRelease#bloom.2FTutorials.2FPrepareUpstream.Preparing_the_Upstream_Repository After merging, I'll do the steps described on the section I just added |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One comment to review, LGTM / feel free to merge afterwards
massrobotics_amr_sender_py/README.md
Outdated
@@ -33,3 +33,27 @@ On you local workspace: | |||
colcon test --packages-select massrobotics_amr_sender | |||
colcon test-result --verbose | |||
``` | |||
|
|||
## Releasing a new version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad memory tells me this is something done by the maintainers, so it's not very useful to mix with usage documentation. It should probably go elsewhere.
Could you do me a favor and check other packages to see if it's common to include the release instructions in the package README?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH most of the packages I've seen don't have a README, but I agree that this shouldn't be here. Actually, these are notes I took while testing commands
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps a separate file, like MAINTAINER_README.md
? I agree the instructions shouldn't be in the README, but I wouldn't just throw them away since they are useful indeed
Changes
setup.py
file version is now obtained frompackage.xml
fileREADME.md
release instructionsvscode
workspace fileNote
The proper release will be done from
foxy-devel
branch, after merging this PR.