gitlab_awesome_release 0.1.0.beta5 → 0.1.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79dcca8a59190f69caa1c4fdcf4ccfd6a3128b24
-  data.tar.gz: 065353fae2858639d9fa75ced13213f5bdc8f7e5
+  metadata.gz: 2ed66cdb87806104213ff64c55a4ef882b40f4af
+  data.tar.gz: 4a2670019037a5bfdbd2f7a934c0230fa91196e6
 SHA512:
-  metadata.gz: 5d5c011aa2d599c46f02e6b667ff766559c96001ead5ccf7ea7bdf1253d25e887afe396fc7d4159718936f6cfa6b712ac99b3e680ffe7ecd7f5b3ffc4d3c8562
-  data.tar.gz: 2085fceb89ed4b4f6e1231cf8479193eb84497dcc3f55d30d73c5d4825e9928e7086b370d1cd89ff7bf7f871acb43d0bdb1f468728c042dc11bb5890b986ece3
+  metadata.gz: 210c2476ac7ab7dfb574eb2eb7258a2dc3266d82880739299f7dbaddb6ff1d55665c22518445f01a2ee964898f1e03bd907b219fa06b0f072b194d814f090fc5
+  data.tar.gz: bfef44f89224418257752c0888dc1cac939bc1fe7df5deb2751d673f2a5c3f84c000f03a1915103ff1eadfaa3a05998d94e89527918eee89d8064c2c8dadbf72

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 ## Unreleased
-[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v0.1.0.beta4...HEAD)
+[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v0.1.0.beta5...HEAD)
 
 
+## v0.1.0.beta5
+[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v0.1.0.beta4...v0.1.0.beta5)
+
+* Refactoring [!9](https://gitlab.com/sue445/gitlab_awesome_release/merge_requests/9) *@sue445*
+* Impl marking [!10](https://gitlab.com/sue445/gitlab_awesome_release/merge_requests/10) *@sue445*
+* from -> from_tag, to -> to_tag [!11](https://gitlab.com/sue445/gitlab_awesome_release/merge_requests/11) *@sue445*
+
 ## v0.1.0.beta4
 [full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v0.1.0.beta3...v0.1.0.beta4)
 

data/README.md

@@ -1,16 +1,17 @@
 # GitlabAwesomeRelease
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab_awesome_release`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Generate changelog from tags and MergeRequests on [GitLab](https://about.gitlab.com/)
 
 [![Gem Version](https://badge.fury.io/rb/gitlab_awesome_release.svg)](https://badge.fury.io/rb/gitlab_awesome_release)
 [![build status](https://gitlab.com/ci/projects/9759/status.png?ref=master)](https://gitlab.com/ci/projects/9759?ref=master)
 [![Dependency Status](https://gemnasium.com/c2e0c69e2a02b4bb66481fb32f368e0e.svg)](https://gemnasium.com/a2f4eb18c1920eb39d8e9f1f807dd830)
 
+## Example
+see [CHANGELOG.md](CHANGELOG.md)
+
 ## Requirements
 
-* Ruby 2.1+
+* Ruby v2.1+
+* GitLab v7.11.0+
 
 ## Installation
 
@@ -30,7 +31,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### `create_note`
+generate changelog
+
+```sh
+$ gitlab_awesome_release create_note --filename=CHANGELOG.md
+```
+
+### options
+All options can be specified in both the command arguments and environment variables
+
+* `--gitlab-api-endpoint` , `GITLAB_API_ENDPOINT` **(either one is required)**
+  * GitLab API endpoint (e.g. `http://example.com/api/v3`)
+* `--gitlab-api-private-token` , `GITLAB_API_PRIVATE_TOKEN` **(either one is required)**
+  * Your private token. see [/profile/account](img/private_token.png)
+* `--gitlab-project-name` , `GITLAB_PROJECT_NAME` **(either one is required)**
+  * Target project (e.g. `group/repo_name`)
+* `--from-tag` , `FROM_TAG`
+  * The first tag to create a changelog
+  * default: oldest tag
+* `--to-tag` , `TO_TAG`
+  * The last tag to create a changelog
+  * default: latest tag
+* `--filename` , `FILENAME`
+  * Filepath to changelog file (e.g. `CHANGELOG.md`)
+  * if empty, output to console
+* `--allow-tag-format` , `ALLOW_TAG_FORMAT`
+  * Tag format for release note heading (regular expresion pattern)
+  * default: `^v?[\d.]+`
+* `--log-level` , `LOG_LEVEL`
+  * Log level `(debug|info|warn|error|fatal|unknown)`
+  * default: `info`
+
+### marking
+Add version label to MergeRequests
+
+example) https://gitlab.com/sue445/gitlab_awesome_release/merge_requests?state=merged
+
+```sh
+$ gitlab_awesome_release marking --from-tag=v0.1.0 --to-tag=v0.2.0
+```
+
+### options
+All options can be specified in both the command arguments and environment variables
+
+* `--gitlab-api-endpoint` , `GITLAB_API_ENDPOINT` **(either one is required)**
+  * GitLab API endpoint (e.g. `http://example.com/api/v3`)
+* `--gitlab-api-private-token` , `GITLAB_API_PRIVATE_TOKEN` **(either one is required)**
+  * Your private token. see [/profile/account](img/private_token.png)
+* `--gitlab-project-name` , `GITLAB_PROJECT_NAME` **(either one is required)**
+  * Target project (e.g. `group/repo_name`)
+* `--from-tag` , `FROM_TAG` **(either one is required)**
+  * The first tag to marking
+* `--to-tag` , `TO_TAG` **(either one is required)**
+  * The last tag to marking
+* `--label` , `LABEL`
+  * Label to be added to the MergeRequest
+  * default: `--to-tag` or `TO_TAG`
+* `--log-level` , `LOG_LEVEL`
+  * Log level `(debug|info|warn|error|fatal|unknown)`
+  * default: `info`
+
+## ProTip
+Environment variables read from `~/.env.gitlab` and current `.env.gitlab`
+
+`~/.env.gitlab` 
+
+```
+GITLAB_API_ENDPOINT=http://example.com/api/v3
+GITLAB_API_PRIVATE_TOKEN=XXXXXXXXXXXXXXXXXXX
+ALLOW_TAG_FORMAT=^v?[\d.]+
+```
+
+current `.env.gitlab`
+
+```
+GITLAB_PROJECT_NAME=group/name
+ALLOW_TAG_FORMAT=^v?[\d.]+
+```
+
+If defined both `~/.env.gitlab` and current `.env.gitlab`, current `.env.gitlab` is priority
+
 
 ## Development
 

data/lib/gitlab_awesome_release/cli.rb

@@ -6,7 +6,11 @@ module GitlabAwesomeRelease
   class CLI < Thor
     DEFAULT_VERSION_FORMAT = "^v?[\\d.]+"
     GITLAB_ENV_FILES = %w(.env.gitlab ~/.env.gitlab)
-    LOG_LEVEL_DESCRIPTION = "Log level (debug|info|warn|error|fatal|unknown)"
+
+    GITLAB_API_DESCRIPTION               = "GitLab API endpoint (e.g. http://example.com/api/v3)"
+    GITLAB_API_PRIVATE_TOKEN_DESCRIPTION = "Your private token"
+    GITLAB_API_PROJECT_NAME              = "Target project (e.g. group/repo_name)"
+    LOG_LEVEL_DESCRIPTION                = "Log level (debug|info|warn|error|fatal|unknown)"
 
     desc "version", "Show gitlab_awesome_release version"
     def version
@@ -14,14 +18,14 @@ module GitlabAwesomeRelease
     end
 
     desc "create_note", "generate changelog"
-    option :filename
-    option :from_tag
-    option :to_tag
-    option :gitlab_api_endpoint
-    option :gitlab_api_private_token
-    option :gitlab_project_name
-    option :allow_tag_format, desc: "Regular expression of tag format", default: DEFAULT_VERSION_FORMAT
-    option :log_level, desc: LOG_LEVEL_DESCRIPTION, default: "info"
+    option :gitlab_api_endpoint,      desc: GITLAB_API_DESCRIPTION
+    option :gitlab_api_private_token, desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
+    option :gitlab_project_name,      desc: GITLAB_API_PROJECT_NAME
+    option :from_tag,                 desc: "The first tag to create a changelog (default: oldest tag)"
+    option :to_tag,                   desc: "The last tag to create a changelog (default: latest tag)"
+    option :filename,                 desc: "Filepath to changelog file (e.g. CHANGELOG.md). if empty, output to console"
+    option :allow_tag_format,         desc: "Tag format for release note heading (regular expresion pattern)", default: DEFAULT_VERSION_FORMAT
+    option :log_level,                desc: LOG_LEVEL_DESCRIPTION, default: "info"
     def create_note
       Dotenv.load(*GITLAB_ENV_FILES)
 
@@ -38,13 +42,13 @@ module GitlabAwesomeRelease
     end
 
     desc "marking", "Add version label to MergeRequests"
-    option :from_tag
-    option :to_tag
-    option :label
-    option :gitlab_api_endpoint
-    option :gitlab_api_private_token
-    option :gitlab_project_name
-    option :log_level, desc: LOG_LEVEL_DESCRIPTION, default: "info"
+    option :gitlab_api_endpoint,      desc: GITLAB_API_DESCRIPTION
+    option :gitlab_api_private_token, desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
+    option :gitlab_project_name,      desc: GITLAB_API_PROJECT_NAME
+    option :from_tag,                 desc: "The first tag to marking"
+    option :to_tag,                   desc: "The last tag to marking"
+    option :label,                    desc: "Label to be added to the MergeRequest"
+    option :log_level,                desc: LOG_LEVEL_DESCRIPTION, default: "info"
     def marking
       Dotenv.load(*GITLAB_ENV_FILES)
 

data/lib/gitlab_awesome_release/project.rb

@@ -101,8 +101,11 @@ module GitlabAwesomeRelease
       "* #{mr.title} [!#{iid}](#{mr_url}) *@#{mr.author.username}*"
     end
 
+    # find MergeRequest with iid
     def merge_request(iid)
-      Gitlab.merge_requests(escaped_project_name, iid: iid).first
+      mr = Gitlab.merge_requests(escaped_project_name, iid: iid).first
+      assert_merge_request_iid(mr, iid) if mr
+      mr
     end
 
     def add_merge_request_label(mr, label)
@@ -136,5 +139,10 @@ module GitlabAwesomeRelease
         str << merge_request_summary(iid) + "\n"
       end
     end
+
+    def assert_merge_request_iid(mr, iid)
+      # NOTE: MR is found, but server is old GitLab?
+      raise "MergeRequest iid does not match (expected #{iid}, but #{mr.iid})" unless iid == mr.iid
+    end
   end
 end

data/lib/gitlab_awesome_release/version.rb

@@ -1,3 +1,3 @@
 module GitlabAwesomeRelease
-  VERSION = "0.1.0.beta5"
+  VERSION = "0.1.0.beta6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_awesome_release
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta5
+  version: 0.1.0.beta6
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,6 +200,7 @@ files:
 - bin/setup
 - exe/gitlab_awesome_release
 - gitlab_awesome_release.gemspec
+- img/private_token.png
 - lib/gitlab_awesome_release.rb
 - lib/gitlab_awesome_release/array_within_ext.rb
 - lib/gitlab_awesome_release/cli.rb