-
Notifications
You must be signed in to change notification settings - Fork 2
Upgrading v0.0.0 Template
How to upgrade from version v0.0.0 (unversioned) to version v1.0.0 (released 28 May 2024).
It is advised to retain a main branch on your instantiated template to simplify this upgrade process. It is assumed for these instructions, that you have this main branch retained.
This is a simple guide, if you need further assistance please open an Issue.
Clone LCAS/main to a new workspace. It is advised to complete this process in a fresh workspace to simplify the process.
git clone https://github.com/lcas/environment_template.git --single-branch -b main
Branches:
| <main>
Add as a remote, the link to your instantiated template. Then checkout the main branch in your repository.
git remote add inst https://github.com/fork/template_name.git
git checkout inst/main
git switch -c inst_main
Branches:
| main
| <inst_main>
Checkout the branch which contains your environment details.
git checkout -b inst_env_n
Branches:
| main
| inst_main
| <inst_env_n> (+maps)
To begin the upgrade, checkout the LCAS/main (on the tag matching the version you wish to upgrade to).
git checkout main
#or
git fetch --all --tags --prune
git checkout tags/v1.0.0
Branches:
| <main> (readme)
| inst_main
| inst_env_n (+maps)
Checkout to the main branch on your instantiated template.
git checkout inst_main
Branches:
| main (readme)
| <inst_main> (readme)
| inst_env_n (readme,+maps)
Then proceed with the merge. When a template is instantiated, it's git history begins new. This means it cannot merge directly as the two branches have different histories. Merge with the argument of --allow-unrelated-histories to circumvent this. This will highlight all of the changes made to main from the point of instantiation.
git merge main --allow-unrelated-histories
Finally, checkout to your environment's branch to merge the changes from your instantiated main into there.
git checkout inst_env_n
Branches:
| main (readme)
| inst_main (readme)
| <inst_env_n> (readme,+maps)
git merge inst_main
This work was supported by AgriFoRwArdS CDT, under the Engineering and Physical Sciences Research Council [EP/S023917/1].
This work was completed in association with the Agri-OpenCore project under Innovate UK grant 10041179.
For citation of the associated workshop publication please use the following bibtex:
@inproceedings{heselden2024unified,
title={Unified Map Handling for Robotic Systems: Enhancing Interoperability and Efficiency Across Diverse Environments},
author={James R. Heselden and Gautham P. Das},
year={2024},
eprint={2404.13499},
archivePrefix={arXiv},
primaryClass={cs.RO},
booktitle={Proceedings of the Workshop on Field Robotics, ICRA 2024},
address={Yokohama, Japan},
doi={10.48550/arXiv.2404.13499}
}
For citation of this software repository please use the following bibtex:
@misc{LCASEnvironmentTemplate,
author = {Heselden, James R. and Das, Gautham P.},
title = {{Environment Template}},
howpublished = {\url{https://github.com/LCAS/environment_template}},
year = {2024},
note = {Accessed: [access date]}
}