README.md in gitlab-4.5.0 vs README.md in gitlab-4.6.0
- old
+ new
@@ -1,19 +1,19 @@
# Gitlab
[![Build Status](https://img.shields.io/travis/NARKOZ/gitlab.svg)](https://travis-ci.org/NARKOZ/gitlab)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/NARKOZ/gitlab.svg)](https://codeclimate.com/github/NARKOZ/gitlab)
-[![Inline docs](http://inch-ci.org/github/NARKOZ/gitlab.svg)](https://inch-ci.org/github/NARKOZ/gitlab)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2e310b334b1b5db4a7e1/maintainability)](https://codeclimate.com/github/NARKOZ/gitlab)
+[![Inline docs](https://inch-ci.org/github/NARKOZ/gitlab.svg)](https://inch-ci.org/github/NARKOZ/gitlab)
[![Gem version](https://img.shields.io/gem/v/gitlab.svg)](https://rubygems.org/gems/gitlab)
[![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/NARKOZ/gitlab/blob/master/LICENSE.txt)
-[website](http://narkoz.github.io/gitlab) |
-[documentation](http://rubydoc.info/gems/gitlab/frames) |
+[website](https://narkoz.github.io/gitlab) |
+[documentation](https://rubydoc.info/gems/gitlab/frames) |
[gitlab-live](https://github.com/NARKOZ/gitlab-live)
Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://docs.gitlab.com/ce/api/README.html).
-As of version `4.0.0` this gem only supports Ruby 2.0+ and Gitlab API v4.
+As of version `4.0.0` this gem only supports Ruby 2.0+ and GitLab API v4.
## Installation
Install it from rubygems:
@@ -52,20 +52,20 @@
Usage examples:
```ruby
# set an API endpoint
-Gitlab.endpoint = 'http://example.net/api/v4'
-# => "http://example.net/api/v4"
+Gitlab.endpoint = 'https://example.net/api/v4'
+# => "https://example.net/api/v4"
# set a user private token
Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
# => "qEsq1pt6HJPaNciie3MG"
# configure a proxy server
Gitlab.http_proxy('proxyhost', 8888)
-# proxy server w/ basic auth
+# proxy server with basic auth
Gitlab.http_proxy('proxyhost', 8888, 'proxyuser', 'strongpasswordhere')
# list projects
Gitlab.projects(per_page: 5)
# => [#<Gitlab::ObjectifiedHash:0x000000023326e0 @data={"id"=>1, "code"=>"brute", "name"=>"Brute", "description"=>nil, "path"=>"brute", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002331600 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:56Z"}>, #<Gitlab::ObjectifiedHash:0x000000023450d8 @data={"id"=>2, "code"=>"mozart", "name"=>"Mozart", "description"=>nil, "path"=>"mozart", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002344ca0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:57Z"}>, #<Gitlab::ObjectifiedHash:0x00000002344958 @data={"id"=>3, "code"=>"gitlab", "name"=>"Gitlab", "description"=>nil, "path"=>"gitlab", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x000000023447a0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:58Z"}>]
@@ -106,15 +106,15 @@
# retrieve all projects as an array
projects.auto_paginate
```
-For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).
+For more information, refer to [documentation](https://rubydoc.info/gems/gitlab/frames).
## CLI
-It is possible to use this gem as a command line interface to gitlab. In order to make that work you need to set a few environment variables:
+It is possible to use this gem as a command line interface to GitLab. In order to make that work you need to set a few environment variables:
```sh
export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
# This one is optional and can be used to set any HTTParty option you may need
# using YAML hash syntax. For example, this is how you would disable SSL
@@ -122,25 +122,25 @@
export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
```
Usage:
-When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
+When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
Usage examples:
```sh
# list users
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#users-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#users-instance_method
gitlab users
# get current user
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
gitlab user
# get a user
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
gitlab user 2
# filter output
gitlab user --only=id,username
@@ -148,11 +148,11 @@
# get a user and render result as json
gitlab user 2 --json
# passing options hash to a command (use YAML)
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
```
## CLI Shell
@@ -175,21 +175,21 @@
# passing options hash to a command (use YAML)
gitlab> create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
```
Web version is available at https://gitlab-live.herokuapp.com
-For more information, refer to [website](http://narkoz.github.io/gitlab).
+For more information, refer to [website](https://narkoz.github.io/gitlab).
## Development
-### With a dockerized Gitlab instance
+### With a dockerized GitLab instance
```shell
-docker-compose up -d gitlab # Will start the gitlab instance in the background (approx. 3 minutes)
+docker-compose up -d gitlab # Will start the GitLab instance in the background (approx. 3 minutes)
```
-After a while, your Gitlab instance will be accessible on http://localhost:3000.
+After a while, your GitLab instance will be accessible on http://localhost:3000.
Once you have set your new root password, you can login with the root user.
You can now setup a personal access token here: http://localhost:3000/profile/personal_access_tokens
@@ -204,20 +204,20 @@
```ruby
Gitlab.users
=> [#<Gitlab::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
```
-To launch the specs,
+To launch the specs:
```shell
docker-compose run app rake spec
```
-#### Want to use Gitlab Enterprise?
+#### Want to use GitLab Enterprise?
Just change the image from `gitlab/gitlab-ce:latest` to `gitlab/gitlab-ee:latest` in the `docker-compose.yml` file.
-### With an external Gitlab instance
+### With an external GitLab instance
First, set the variables to the correct values in the `docker.env` file.
Then, launch the tool: