You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Prerequisite: Set Up

The actions described in this section depend on having the requisite set of tools and settings on your development machine. See Setting Up Your Development Environment.

Using the Command Line to Clone the Repository

  1. Move to the folder at the root of your development directory. For example:
    cd C:\Users\<user>\Documents\work
     
  2. Add a remote pointer to the Gerrit server that hosts your repository using either SSH or HTTPS. (Note: <REPONAME>s are given in various Development Guides.
    Using SSH:
    git remote add origin ssh://USERNAME@gerrit.openecomp.org:29418/<REPONAME>

    Using HTTPS:
    With HTTPS, first you will need the Gerrit HTTP-generated password for each HTTPS operation with Git/Gerrit.

    git remote add origin     https://USERNAME@gerrit.openecomp.org/r/a/<REPONAME>
     
  3. Now clone the remote repository. Since we clone in the current folder, it will create a subfolder with the remote copy.
    Using SSH:
    git clone ssh://USERNAME@gerrit.openecomp.org:29418/<REPONAME>

    Using HTTPS:
    With HTTPS, first you will need the Gerrit HTTP-generated password for each HTTPS operation with Git/Gerrit.

    git clone https://USERNAME@gerrit.openecomp.org/r/a/<REPONAME>

Setting up IntelliJ to Clone and Commit to Gerrit

Visit https://gerrit.openecomp.org and log in, using your Linux Foundation identity. Here, you will be able to view the names of Projects to which you have access.

On top of the project listing, the web site provides you the command to clone the whole project, such as:


The project can be downloaded in either of two ways, via HTTP url or SSH url.

IntelliJ and SSH URL (Recommended)

To download the project with ssh url, you need to add the ssh key into the Linux Foundation Gerrit website.


In the Settings window, select SSH Public Keys. Put your public key of your machine into the window and click Add.


The steps to create the SSH Key could be found in the following page: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/

Click ssh under the Linux Foundation Project page, it will display the url to use to clone the project.


Then open your IntelliJ, click File -> Settings -> Version Control -> Gerrit, enter the URL for the Linux Foundation Gerrit website, your Linux Foundation username and password and click OK. To test whether the connection is good, you can also click the Test button before clicking OK.


Then open File -> New -> Project from Version Control -> Git to open Clone Repository window. Enter the ssh url you have found above, chose your Parent Directory and Directory Name and click Clone to clone the project.


For the first downloading, a OpenSSH window will appear to authenticate the host. Enter yes in the command location and click OK to progress.


IntelliJ and HTTP URL

Open IntelliJ and click File -> Settings -> Version Control -> Gerrit. In the resulting dialog box, enter the Gerrit URL as shown above, along with your Linux Foundation username and password. To test whether the connection is good, you can click the Test button:

https: Required

The URL must use https:, not http:.

Once you have entered this information, click OK:


Then open File -> New -> Project from Version Control -> Git to open Clone Repository window. Enter the http url you have found above, but with https not with http, chose your local Parent Directory and Directory Name and click Clone to clone the project.


A window will pop up to input the user name and password. The user name is the username of your Linux Foundation account, and the password is the Gerrit HTTPS password generated during setup.



Pushing changes for review using a command line

Now let's add some files and add our first commit with an associated message:

git add somefiles
git commit -m "My first Awesome commit"

Note that this is just an example and the commit message should be much more explicit than that.

Now that everything is ready, you can sign off your commit, make sure that your git user matches your Linux Foundation identity, as this will be verified by the Gerrit server.

git review -s

You may be prompted for your Linux Foundation account password.

Now let's verify the commit hook work, this will show you the commit message and the sign off entry

git commit -as --amend

You can automatically add the signature for all your commits by setting the git configuration : git config --global format.signoff true

Eventually, we can push the change to the gerrit server

git review

The code should now appear in the gerrit web interface, it needs a committer to approve it with a +2 and also move the verifed flag to +1, to do so, the committer can open the gerrit UI and click on the open review list



Then click on the Reply button, you can also add reviewers for their inputs, add a review comment, and move the flags to +2 and +1



Once a committer approves it, the code can be merged to the master branch

If issues are found, both contributors and committers can amend the review (use the top-left download link on the review screen to get the direct clone commands that would download the reviewed code in a local repository)

Similarly to the above steps, do the needed modifications, and push the changes (again after signing them) using git review

Note that you can also work on local branch, gerrit will automatically use your local branch name as a Topic for the review, allowing you to share branches between team members

More details on how to use gerrit : https://gerrit.openecomp.org/r/Documentation/index.html

Commit Changes

Once you have made changed in the code, before push the changes, you should commit the code locally first.

To do that, go to the Version Control window, under Local Changes, right click the changed files and click Commit Changes....


In the Commit Changes window, enter the Commit Message, select Sign-off commit option and click Commit button.


Then go to the Terminal window, use command apt-get install git-review to install git-review plugin in the machine, if not already installed.


Once installed, under root location of the project enter command git config --list, make sure the email address listed is exactly the same as the one you used in your Linux Foundation account.


If your address is not present or not the same as the one defined in Linux Foundation account, enter command git config --global user.email "jondoe@somewhere.com".

Then enter command git commit -as --amend to show the commit message and the sign off entry, as shown below. Make sure the email address is the exactly the same as the email you used in the Linux Foundation account. If not, update the address.


Then enter command git review to upload the changed code into the Linux Foundation for reviewing.


Go to Gerrit window and refresh, the committed changes will be shown in the window. Right click the commit, you can find the tab to Add Reviewers for reviewing or Abandon the changes if you don't want it any more.


If you have been selected as the reviewer of the changes. You can right click the corresponding commit and click Review, Code-Review to give your score and comments for the change.



 — Should we put the above section in a sub section




  • No labels