Porting across bloom documentation #2375

ijnek · 2022-03-28T10:29:40Z

Resolves: #2357

It would be great to address as many issues as we can while porting the documentation across.
I haven't tried out the new instructions yet.

kurshakuz

Thank you for starting this! As you mentioned that you have not tested it yet, I will just leave some high-level suggestions. Can you check the build status and fix the warnings on trailing whitespaces and missing newlines at end of files?
I would also suggest to make every sentence to be completely on a one line, this makes reviewing much easier.
Finally, I would like to leave the Minor differences from ROS 1 Bloom section somewhere, as it still may be useful for developers migrating to ROS 2.

source/How-To-Guides/Releasing/Releasing-a-Package.rst

ijnek · 2022-04-01T22:20:53Z

@kurshakuz
I appreciate the early review 👍

dkroenke · 2022-04-19T08:19:46Z

It hint to the package maintainer can be to ensure that a clean and up-to-date rosdep is available before releasing since bloom-release generates the package dependencies from rosdep.

clalancette · 2022-04-19T12:28:53Z

It hint to the package maintainer can be to ensure that a clean and up-to-date rosdep is available before releasing since bloom-release generates the package dependencies from rosdep.

My understanding is that bloom ensures it is up-to-date (it always runs rosdep update during the release process). However, it does not currently detect whether you are using a custom rosdep database, which is where you could run into trouble.

ijnek · 2022-04-25T12:39:34Z

FYI - I am still working on it but still requires time. It isn't ready to be reviewed yet.

audrow · 2022-07-25T20:17:58Z

It would be nice to have a checklist for keeping track of what has been ported or not (perhaps in #2357). Also, it would probably be easiest for us as reviewers if this was split into several smaller PRs, like one ported page, or one small but related group of pages.

@ijnek, thanks for taking on this large task!

ijnek · 2022-07-27T04:00:36Z

@audrow Thanks for your suggestion, I agree that I'll have to break this up into multiple PRs for easier reviewing, I will start a checklist in #2357 per your suggestion.

Signed-off-by: Kenji Brameld <[email protected]>

…istro Signed-off-by: Kenji Brameld <[email protected]>

Signed-off-by: Kenji Brameld <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>

Signed-off-by: Kenji Brameld <[email protected]>

ijnek · 2022-07-28T02:39:39Z

@clalancette Thank you for reviewing so quickly!
I'm glad that most of the content was fine. I agreed with all of your points, and have made all the changes as necessary.

…ials Signed-off-by: Kenji Brameld <[email protected]>

clalancette

All right, just a few more minor fixes, then this will be good to go.

clalancette · 2022-07-28T12:27:00Z

source/How-To-Guides/Releasing/Releasing-a-Package.rst

+   Release-Track
+
+**Releasing a package makes your package available on the public ROS 2 buildfarm.**
+After you have created a package, this is the next step towards getting your package into the publicly available Debian packages!


I think we can just remove this sentence now, as it is redundant with the next one.

This should be good now

source/How-To-Guides/Releasing/_Personal-Access-Token.rst

source/How-To-Guides/Releasing/_Install-Dependencies.rst

source/How-To-Guides/Releasing/_Clean-Up-Changelog.rst

Signed-off-by: Kenji Brameld <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>

Signed-off-by: Kenji Brameld <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>

Signed-off-by: Kenji Brameld <[email protected]>

clalancette

This is absolutely fantastic. Thanks again @ijnek for all of the work here, and the iteration. I'm going to go ahead and merge this, and also backport to the other distributions.

* Port across all of the bloom documentation from wiki.ros.org, updating it for ROS 2 in the process. Signed-off-by: Kenji Brameld <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 90c48da)

* Port across all of the bloom documentation from wiki.ros.org, updating it for ROS 2 in the process. Signed-off-by: Kenji Brameld <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 90c48da) Co-authored-by: Kenji Brameld <[email protected]>

kurshakuz reviewed Mar 31, 2022

View reviewed changes

source/How-To-Guides/Releasing/Releasing-a-Package.rst Outdated Show resolved Hide resolved

ijnek force-pushed the ijnek-bloom branch 2 times, most recently from e092295 to f256d67 Compare April 1, 2022 21:57

This was referenced Apr 3, 2022

Porting catkin_* scripts to ament ros-infrastructure/catkin_pkg#330

Closed

rot_conv_lib: 1.0.2-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#32633

Closed

dkroenke mentioned this pull request Apr 19, 2022

Renaming of iceoryx_utils to iceoryx_hoofs ros2-gbp/iceoryx-release#2

Closed

SteveMacenski mentioned this pull request May 27, 2022

adding rosdep tutorial #2561

Merged

This was referenced Jun 7, 2022

Move bloom configuration details from wiki to bloom ReadTheDocs ros-infrastructure/bloom#674

Closed

User documentation ros-infrastructure/catkin_pkg#343

Open

audrow self-assigned this Jun 14, 2022

ijnek mentioned this pull request Jul 13, 2022

Dropping support for non-git repository types (svn, hg, etc.) ros-infrastructure/bloom#681

Open

ijnek force-pushed the ijnek-bloom branch from 984333b to 2764e9e Compare July 23, 2022 00:50

ijnek added 12 commits July 27, 2022 15:51

create Bloom directory

74b1456

Signed-off-by: Kenji Brameld <[email protected]>

port across steps 1 and 2

420dd41

Signed-off-by: Kenji Brameld <[email protected]>

section 3

038b978

Signed-off-by: Kenji Brameld <[email protected]>

add Releasing your packages section

774a643

Signed-off-by: Kenji Brameld <[email protected]>

add Configure a Release Track, upto Notifying the Build Farm

75a86ae

Signed-off-by: Kenji Brameld <[email protected]>

increase table of contents depth to 3 and port next steps across

68ca014

Signed-off-by: Kenji Brameld <[email protected]>

update first time release instructions

fad3e3c

Signed-off-by: Kenji Brameld <[email protected]>

add releasing a package update

6de4807

Signed-off-by: Kenji Brameld <[email protected]>

add pages for releasing third party package and relesaing for a new d…

90367f5

…istro Signed-off-by: Kenji Brameld <[email protected]>

add instructions for releasing for a new distro

618c9a7

Signed-off-by: Kenji Brameld <[email protected]>

sort instructions to reduce duplication

b6ca1a1

Signed-off-by: Kenji Brameld <[email protected]>

write page on ros2-gbp

f225531

Signed-off-by: Kenji Brameld <[email protected]>

ijnek and others added 7 commits July 28, 2022 08:19

Update source/How-To-Guides/Releasing/Release-Track.rst

1693217

Co-authored-by: Chris Lalancette <[email protected]>

Update source/How-To-Guides/Releasing/Release-Track.rst

d54b565

Co-authored-by: Chris Lalancette <[email protected]>

Update source/How-To-Guides/Releasing/Release-Track.rst

fd827b7

Co-authored-by: Chris Lalancette <[email protected]>

Update source/How-To-Guides/Releasing/GitHub-Manual-Authorization.rst

f018777

Co-authored-by: Chris Lalancette <[email protected]>

Update source/How-To-Guides/Releasing/GitHub-Manual-Authorization.rst

344f8af

Co-authored-by: Chris Lalancette <[email protected]>

add more info about releasing a package

77d3112

Signed-off-by: Kenji Brameld <[email protected]>

remove "Bash Script for setting up OAuth Token"

6cc878a

Signed-off-by: Kenji Brameld <[email protected]>

increase importance of pats by including it as a section in the tutor…

6b6c2a0

…ials Signed-off-by: Kenji Brameld <[email protected]>

ijnek force-pushed the ijnek-bloom branch from 41fd5f8 to 6b6c2a0 Compare July 28, 2022 02:52

clalancette requested changes Jul 28, 2022

View reviewed changes

ijnek and others added 6 commits July 29, 2022 09:40

avoid repeating in releasing-a-package.rst

d0b5be4

Signed-off-by: Kenji Brameld <[email protected]>

Update source/How-To-Guides/Releasing/_Personal-Access-Token.rst

bafe378

Co-authored-by: Chris Lalancette <[email protected]>

remote note that

750364e

Signed-off-by: Kenji Brameld <[email protected]>

Update source/How-To-Guides/Releasing/_Install-Dependencies.rst

36a9883

Co-authored-by: Chris Lalancette <[email protected]>

Update source/How-To-Guides/Releasing/_Clean-Up-Changelog.rst

dd934eb

Co-authored-by: Chris Lalancette <[email protected]>

update isntructions to install dependenices

309edf6

Signed-off-by: Kenji Brameld <[email protected]>

clalancette approved these changes Jul 29, 2022

View reviewed changes

clalancette added the backport-all backport at reviewers discretion; from rolling to all versions label Jul 29, 2022

clalancette merged commit 90c48da into ros2:rolling Jul 29, 2022

mergify bot mentioned this pull request Jul 29, 2022

Porting across bloom documentation (backport #2375) #2910

Merged

mergify bot mentioned this pull request Jul 29, 2022

Porting across bloom documentation (backport #2375) #2911

Merged

mergify bot mentioned this pull request Jul 29, 2022

Porting across bloom documentation (backport #2375) #2912

Merged

ijnek deleted the ijnek-bloom branch July 29, 2022 18:14

Porting across bloom documentation #2375

Porting across bloom documentation #2375

Uh oh!

Conversation

ijnek commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kurshakuz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ijnek commented Apr 1, 2022

Uh oh!

dkroenke commented Apr 19, 2022

Uh oh!

clalancette commented Apr 19, 2022

Uh oh!

ijnek commented Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

audrow commented Jul 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ijnek commented Jul 27, 2022

Uh oh!

ijnek commented Jul 28, 2022

Uh oh!

clalancette left a comment

Choose a reason for hiding this comment

Uh oh!

clalancette Jul 28, 2022

Choose a reason for hiding this comment

Uh oh!

ijnek Jul 29, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clalancette left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ijnek commented Mar 28, 2022 •

edited

Loading

kurshakuz left a comment •

edited

Loading

ijnek commented Apr 25, 2022 •

edited

Loading

audrow commented Jul 25, 2022 •

edited

Loading