Skip to content

Workspace Setup

Andrew Rouse edited this page Jul 20, 2023 · 15 revisions

Setting up the Open Liberty repository and workspace


Prerequisite : Clone the open-liberty repository

You should have already cloned the Open Liberty repository as part of cloning and building Open Liberty.


Step : Create a fork of open-liberty

To contribute to open-liberty, you need a fork of the repository.

Navigate to the open-liberty page and click the Fork button in the top upper right corner and select your account as the location to hold the fork. Already have a fork, you say? Well, click the Fork button anyway, and you will see your existing fork.
You need a fork called named <github-user>/open-liberty - if you see a fork called <something-else>/open-liberty, this is not what you need for this step.


Step : Add your fork as a git remote

Your fork is the outbound part of the git triangular workflow. To allow you to push to your fork, we need to add it as a git remote.

GitHub Triangular Workflow

cd open-liberty

git remote add my_fork git@github.com:<your username>/open-liberty.git

Next, configure the local repository to push your commits to the fork repository you created above:

git config remote.pushdefault my_fork

This will now pull from origin, the main repository, and push to the fork, your fork repository.

This option requires at least Git 1.8.4. It is also recommended that you configure

git config push.default simple

unless you are already using Git 2.0 where it is the default.

You can run the following command to verify your triangle was created successfully:

git remote -v

You should see output similar to the following:

$ git remote -v

my_fork git@github.com:`<your username>`/open-liberty.git (fetch)
my_fork git@github.com:`<your username>`/open-liberty.git (push)
origin  git@github.com:OpenLiberty/open-liberty.git (fetch)
origin  git@github.com:OpenLiberty/open-liberty.git (push)

Finally, IBM contributors may need to configure their Artifactory Auth Token.