Semantic versioning for repositories in the autoware.repos

[sasakisasaki]

(CC: @Shin-kyoto)

Ultimate Goal

Control and monitor the sub-repositories' version in the autoware.repos periodically

What are ongoing?

What we are currently doing is:

• Assuming using the Github Action, preparing scripts to detect the update of sub-repositories by semantic versioning such as v1.2.3
• As the update is detected, create the PR automatically to the parent repository on where the autoware.repos exists

The reason of this approach is, as the number of repositories increases, it would become difficult to catch up all the update in sub-repositories.

Our idea above would be helpful to find the update of sub-repositories. But we found there are some issues to be solved. For example,

• Is the PR created for every update by tag? Or for patch/minor/major update?
  • If the number of PR becomes huge, how to review them?
• From which branch to which branch is this PR intended to be merged?
  • Personally, it might be better to have a develop branch to keep main stable.

This is just a quick our idea and we want to find the best solution from all your informative and insightful ideas and any questions. It is highly appreciated if you kindly feel free to join and feel free to provide your ideas. Thank you in advance!

Reference:

• https://github.com/orgs/autowarefoundation/discussions/4671

[youtalk]

Note that this PR will start versioning the core repositories in autoware.repos.
#4963

[sasakisasaki]

@mitsudome-r @xmfcx ( CC: @Shin-kyoto ) For a testing purpose in the semantic versioning, we have created following the dummy repository. We'll do continuous testing on this repo. Thank you so much for your cooperation!

Repo: https://github.com/autowarefoundation/autoware_dummy_repository

[sasakisasaki]

Starting testing on the repository 👍

[sasakisasaki]

Tests to be performed (perhaps will be updated later)

Repository Update Automation Requirements

Premise

• Target repositories must have tags matching the pattern: semantic_version_pattern = r'\b(v?\d+\.\d+(?:\.\d+)?(?:-\w+)?(?:\+\w+(\.\d+)?)?)\b'
  • This pattern can handle following example tags

    "0.0.1",
    "v0.0.1",
    "ros2-v0.0.4",
    "xxx-1.0.0-yyy",
    "2.3.4",
    "v1.2.3-beta",
    "v1.0",
    "v2",
    "1.0.0-alpha+001",
    "v1.0.0-rc1+build.1",
    "2.0.0+build.1848",
    "2.0.1-alpha.1227",
    "1.0.0-alpha.beta",
    "ros_humble-v0.10.2"

• If updates occur in multiple repositories, create a separate PR for each repository

Test Cases

The following tests should pass (using dummy repositories is acceptable):

1. Duplicate PR Prevention

   • Executing the same Github Action multiple times should not create duplicate PRs with identical content

2. Multiple Repository Updates

   • When updates occur simultaneously in two or more repositories, PRs should be created for each affected repository

3. Idempotent Behavior

   • The operation should behave as expected and be idempotent, even if the target branch already exists locally or remotely
     • Examples:
       • a. No branches or PRs should be created for anything other than version updates of sub-repositories where tag updates have occurred
       • b. The Github Action should not produce errors like "branch already exists"
       • c. Github Action log output should remain consistent across runs, differing only in timestamps (excluding the initial PR creation)

4. Post-Merge Behavior

   • After a PR is merged, no unexpected behavior should occur
     • Examples:
       • a. PRs unrelated to the update should not be created
       • b. If a branch is deleted during the merge process, it should not be pushed again

[sasakisasaki]

Now the review is ongoing.
autowarefoundation/autoware-github-actions#317

[sasakisasaki]

Merged. Let me close this discussion. Reopening, any comments, and any proposals are appreciated and welcome!

[sasakisasaki]

Re-opened as an issue was found. Now the review is ongoing in this PR.

[sasakisasaki]

Merged. The further feature improvement would be discussed in the another discussion (will be shared later here).
#5295

[sasakisasaki]

The next step is ongoing in this discussion:
https://github.com/orgs/autowarefoundation/discussions/5305