Skip to content
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

feat: add autoware_geography_utils from autoware.universe with history #103

Closed
wants to merge 5 commits into from

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented Dec 4, 2024

Description

This is a test PR.

I've ran these commands:

sudo apt update
sudo apt install git-filter-repo

a fresh clone

a@b:~/projects$ git clone https://github.com/autowarefoundation/autoware.universe.git
a@b:~/projects$ cd autoware.universe
a@b:~/projects/autoware.universe$ git filter-repo --path common/autoware_geography_utils
a@b:~/projects/autoware.universe$ git checkout -b feat/add-autoware_geography_utils
a@b:~/projects/autoware.universe$ git remote add core https://github.com/autowarefoundation/autoware.core.git
a@b:~/projects/autoware.universe$ git rebase --root feat/add-autoware_geography_utils --onto core/main

and pushed.

This kept the commits that contributed to this package intact and rebased on top of the main.

How was this PR tested?

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

esteve and others added 5 commits December 4, 2024 20:19
… (#7790)

* refactor(geography_utils): prefix package and namespace with autoware

Signed-off-by: Esteve Fernandez <[email protected]>

* move headers to include/autoware/

Signed-off-by: Esteve Fernandez <[email protected]>

---------

Signed-off-by: Esteve Fernandez <[email protected]>
* update maintainers

Signed-off-by: Yamato Ando <[email protected]>

* add author

Signed-off-by: Yamato Ando <[email protected]>

---------

Signed-off-by: Yamato Ando <[email protected]>
* unify package.xml version to 0.37.0



* remove system_monitor/CHANGELOG.rst



* add changelog



* 0.38.0

---------

Signed-off-by: Yutaka Kondo <[email protected]>
@xmfcx xmfcx requested review from youtalk and mitsudome-r December 4, 2024 17:30
@xmfcx xmfcx self-assigned this Dec 4, 2024
@xmfcx
Copy link
Contributor Author

xmfcx commented Dec 4, 2024

@youtalk @mitsudome-r

This keeps the commits intact but most of the reasoning is within the actual PR links.

Maybe it's better to have it merged without the history.

Because the history before moving to this repo can be best traversed within the original universe repository.

And the links in the commit titles (like feat!: replace tier4_map_msgs with autoware_map_msgs for MapProjectorInfo (#9392) )
these numbers are large and refer to universe PRs. Won't work from this repository.

I'd prefer to merge as a fresh package like in:

EDIT:
By the way, because the autoware_ prefix task renamed the folder, the git-filter-repo was able to retrieve the history until the refactor operation PR.

@xmfcx
Copy link
Contributor Author

xmfcx commented Dec 4, 2024

Also @youtalk -san, I didn't need to use git subtree split while doing this.

Shared my steps in the description above.

Did I achieve the end result you were proposing here?

Commits of this PR: https://github.com/autowarefoundation/autoware.core/pull/103/commits

@autowarefoundation autowarefoundation deleted a comment from github-actions bot Dec 4, 2024
@youtalk
Copy link
Member

youtalk commented Dec 4, 2024

@xmfcx I believe that the commit history should still be preserved despite the inconsistencies in links and renaming the package. Since we basically use squash merges, the link issue isn’t much of a problem. I think being able to trace the history from the descriptions of this commit or this PR are valuable.
I think merge commits are better than squash merges in case of these porting PRs but they disrupt the linear history.

Ref.

Changelog for package autoware_geography_utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0.38.0 (2024-11-08)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to maintain the commit history, we’ll need to add a commit to reassign version numbers. This is troublesome. As @xmfcx suggested, copying might be a better option...

@xmfcx
Copy link
Contributor Author

xmfcx commented Dec 5, 2024

I’m grateful for your consideration ❤️
The commit history will remain within the Universe repository, so there's no need to duplicate it here.

People can trace back from these PRs back to Universe, that should suffice 👍
And they can make use of the links in the commit messages to the PR's themselves to see the reason why each item was implemented.

@xmfcx xmfcx closed this Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants