Workspace opensourcing

[agalbachicar]

List of tasks that would allow the workspace to be public

• Solidify build scripts, identify supported platforms
• Review installation documentation Development workflows #139
• Other documentation links Generate great documentation #229
• Limited CI builds on public facing repo? Use GitHub Actions CI #136
• Quality of life improvements
• General Roadmap of the next 6th months of development
• We'd need a logo :-), trademark, legal protections
• Licenses
• Patenting
• Contributions
• Questions and requests
• Demos

[agalbachicar]

Internal licenses were set to BSD Clause 3 in all repositories.

[agalbachicar]

@stonier and @liangfok to review and provide guidelines of future work towards opensourcing.

[francocipollone]

Towards open-sourcing

We have a green light for open-sourcing so let's put together some info and the next steps.

Repositories

Action item: Add a ✔️ to the repo that is confirmed is going public, a ❌ otherwise.

• maliput_infrastructure ✔️
• repos_index ❌ --> Merge it into maliput_infrastructure
• maliput ✔️
• maliput_py ✔️
• maliput_dragway ✔️
• maliput_drake ✔️
• maliput_multilane ✔️
• maliput_malidrive ✔️
• maliput_integration ✔️
• maliput_integration_tests ✔️
• maliput_object ✔️
• delphyne ✔️
• delphyne_gui ✔️
• delphyne_demos ✔️
• maliput_documentation ✔️

optional:

• lanelets_eval: This repo isn't part of the maliput ecosystem, therefore, lanelets_eval is not in the loop when API is being modified. In consequence, if we meant to opensource it, we would need to couple to a particular maliput release(once we have releases in maliput) to guarantee correct functioning.

To note: The following repositories are already opensourced

• drake_vendor
• ament_cmake_doxygen

The repositories are expected to be migrated to another organization and from there make them public.
Note: When moving the repositories, it is expected that the repositories' ownership simply changes from one organization to another. No need to move code around. History and issues are expected to be migrated as a whole.

Steps

1- Before moving to another organization

Note: Neither of these bullets blocks open-sourcing.

• Documentation
  • Contribution page Adds contribuiting and code of conduct pages. maliput_documentation#88
    • Point all repos' CONTRIBUITING file to online contribuiting.
  • Update Roadmap
  • Update Documentation page: It is full of links to Doxygen generated pages. It could be more verbose
  • Update Gallery page: Demos are just thrown into the page.
  • Update all repos' README to correctly point to correspondent documentation.
• Dependencies:
  • pybind11's custom fork from RobotLocomotion. It could be solved by moving to focal. Use system pybind11 instead of custom version. #225
  • Remove dsim-docs-bundler from maliput ecosystem. Remove dsim_docs_bundler from maliput ecosystem #251
  • ament_export_interfaces: CMake deprecation warnings for foxy #256
• pendings maliput's api changes
  - Lane: ToLanePosition / ToSegmentPosition methods. maliput#496
  - api::FindRoadPosition behavior  maliput#494
• Collapse repos_index into maliput_infra Merge repos_index repo into maliput_infraestructure #250
• OS/ROS support
  • Remove dashing support. Support solely focal + foxy configuration #249

2- Move to new organization

• Move repositories
  • maliput
  • maliput_py
  • maliput_dragway
  • maliput_drake
  • maliput_multilane
  • maliput_malidrive
  • maliput_integration
  • maliput_integration_tests
  • maliput_object
  • delphyne
  • delphyne_gui
  • delphyne_demos
  • maliput_infrastructure
  • maliput_documentation

3- After moving to new organization(still private)

• License: Change TRI Copyright to be TBD. Updates license files before going public #257

4- Going public

Go public repo by repo

• maliput
• ...
• ...

For each repository:

• Security
  • Check user permissions.
  • Check secured branches.
    • main branch.
    • 1 approval requested
    • request CI to pass
    • squad & merge

5- After going public

• CI:
  • Secrets won't be longer needed.
  • rely on ros-tooling for colcon build and test. [META] CI: Refactor CI workflows to rely on ros-action-ci instead #268
  • Migrate to use ros build farm. [META] Maliput repos in the ROS build farm #269
• Documentation:
  • Define maliput_documentation page's name.(From shiny-fiesta to TBD)
• Repo management:
  • Adds issue templates.

[agalbachicar]

About making the repos public, a few important steps:

• Check user permissions.
• Check secured branches.

[tfoote]

Preparing release repositories: ros2-gbp/ros2-gbp-github-org#68

I have skipped infrastructure, drake, and delphyne ones for the first cycle.

[francocipollone]

Preparing release repositories: ros2-gbp/ros2-gbp-github-org#68

I have skipped infrastructure, drake, and delphyne ones for the first cycle.

Just in case, according to dependencies, maliput_drake is necessary for some of the maliput backends. And maliput_documentation depends on delphyne repos.

[tfoote]

Ok, I'll test out maliput and we can work out the correct order and repos necessary after that.