Merging external code into ACME using git subtree

This page is for integrators who will be bringing in code or changes to code from an external repository. This page describes the process where the code will be integrated into the ACME repository as a git subtree. There are three possible workflows; Inserting in a new external to ACME as a subtree, replacing original ACME code with an external, and merging in changes from an external into an ACME subtree. Each workflow is outlined below followed by sections showing details for various workflow step types.

Some Terminology

<external-subdir> refers to the place in the ACME tree where the external code resides (or will reside).

<external_name> is a name you give to the external so that you can refer to the external repository.

<external_url> is the URL for the external repository.

<external_commit> refers to a branch name (<external_url>/<branch_name>), a commit, or a tag name from the external repository.

Insert new external subtree into ACME

Create and switch to a branch in which to conduct the work. Be sure to follow the branch naming conventions and other development practices. If the external code is to be completely replaced, create the branch from the commit where the code was last brought into the ACME repository (similar for the procedure for fixing a bug). The branch name should follow the form github-username/component/component.<version>_import.
Add external git repo to as a remote in your local repository copy (git remote add -f --tags <external_name> <external_url>).
Add code from external git repo to ACME (git read-tree --prefix=<external_subdir>/ -u <external_commit>).
Commit the change (git commit).
Test and submit a pull request as defined in the development practices page.

Replace original (unmodified) ACME code with external subtree

Verify that the external code in the ACME repository has been not been modified since the initial commit (cd <external-subdir>; git diff --name-only v0.0 .). If there are changes (non-blank output), follow the 'Merge changes from external into ACME subtree' workflow below.
Create and switch to a branch in which to conduct the work. Be sure to follow the branch naming conventions and other development practices. If the external code is to be completely replaced, create the branch from the commit where the code was last brought into the ACME repository (similar for the procedure for fixing a bug). The branch name should follow the form github-username/component/component.<version>_import.
Add external git repo to as a remote in your local repository copy (git remote add -f --tags <external_name> <external_url>).
Remove the code from your working copy (git rm -r <external-subdir>).
Add code from external git repo to ACME (git read-tree --prefix=<external_subdir>/ -u <external_commit>).
Commit the change (git commit).
Test and submit a pull request as defined in the development practices page.

Merge changes from external into ACME subtree

Create and switch to a branch in which to conduct the work. Be sure to follow the branch naming conventions and other development practices. If the external code is to be completely replaced, create the branch from the commit where the code was last brought into the ACME repository (similar for the procedure for fixing a bug). The branch name should follow the form github-username/component/component.<version>_import.
Add external git repo to as a remote in your local repository copy (git remote add -f --tags <external_name> <external_url>).
Merge from external git repo to ACME (git merge --squash -X subtree=<external_subdir> --no-commit <external_commit>).
Commit the change (git commit).
Test and submit a pull request as defined in the development practices page.

Note that <external_name> can be a branch name, a commit, or a tag name.

Filter by label

There are no items with the selected labels at this time.