allegro_release 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46db88aa057e9f57a49449d05d2b62fca123f5b1
-  data.tar.gz: 6807e8cdec58babbd6d4a79933b3f02e4da9de49
+  metadata.gz: 21cd14882704d7d59db9e50860adadb65c617268
+  data.tar.gz: 634e64b48221019aab86036997a29910cc68922f
 SHA512:
-  metadata.gz: 4bd37a4783fe439c8cf6807b21780d02604350b98f44931a31af3141d2525db0bdbe519799ceb126e11826f336d6c7ca59405a1a4d2a14022ba1b22345d7d257
-  data.tar.gz: 3b33250f736cb388eabde4b11b6044acd8b5da34dd3e1b9fb4663085bbbfaaa761e6c8f13a06872986a80c6bc2ead5cecdee15953fcdebb18eef0f820941942b
+  metadata.gz: e1c730b3051c8a4094a4ae384472b4e4bb15cc67bf4cb94b0f958a0724f60f7a05cfe62628bc0dbdb5162de52c28210da668bd0b7784c9abc1d72033d78d30b7
+  data.tar.gz: 4fd502a9e25f6db3d808c9058335753ba156e8ec83535e6a61d34249d72c985db757ff54687fb8a585bfbb29f1ce5f8770df63f1e0c4c3de038b25615d7d7a4f

data/README.md

@@ -1,9 +1,102 @@
-# Release
+### `allegro_release` tool
 
-## Installation
+`allegro_release` is a dedicated tool that helps in releasing a pod.
 
-## Usage
+#### Prerequests
 
-## Development
+In order to properly use `allegro_release` you need to install [`atlassian-stash`](http://blogs.atlassian.com/2012/11/stash-pull-requests-from-the-command-line/) gem:
 
-## Contributing
+```sh
+gem install atlassian-stash
+```
+
+After installation, run `stash configure` to configure Stash instance (you will have to run `stash configure` every time you change your password, which currently is once per month). The following prompts should appear:
+
+```sh
+Bitbucket Server Username: <your_username> (go to "View Profile" in upper-right corner of Stash)
+Bitbucket Server Password (optional): <your_password>
+Bitbucket Server URL: https://stash.allegrogroup.com/
+Remote (optional): <leave_empty>
+Create a git alias 'git create-pull-request'? n
+```
+
+#### Installation of `allegro_release`
+
+Run:
+
+```sh
+gem install allegro_release
+```
+
+
+### Procedure flow
+
+If you don't want to use `allegro_release` just follow the steps in **What it does?** sections.
+
+#### Step 1
+
+Run command in root of repository where `.podspec` is.
+
+```sh
+allegro_release (major|minor|patch)
+```
+
+* `major` increases major (X.0.0) version of pod.
+* `minor` increases minor (0.X.0) version of pod.
+* `patch` increases patch (0.0.X) version of pod.
+
+**What it does?**
+
+1. Checkouts `develop` branch and pulls changes from repository.
+2. Creates new branch named `release_<version>`.
+3. Bumps the version in `.podspec` accordingly to chosen option.
+4. Updates `CHANGELOG.md` if available in the repository. Precisely, the tool is updating release date of release version and adds placeholders for next version on top of the file. `CHANGELOG.md` must follow the convention (explained below) used in repositories in order for this step to work.
+5. Checks if `.podspec` file is valid via `pod lib lint`.
+6. Commits all the changes. During this step `allegro_release` is asking the user for release issue JIRA ID.
+7. Pushes the branch to the remote repository.
+8. Creates pull request from `release_<version>` to `develop`.
+
+##### CHANGELOG.md convention
+
+File line numbers are on the left.
+
+```
+1. # CHANEGLOG
+2.
+3. ## Version X.X.X
+4. #### Unreleased
+5.
+6. - (added) # Some unreleased changes
+7. 
+8. ## Version 2.2.2
+9. ### Released 01.01.2016
+10.
+11. - (modified) # Some released changes and the rest of CHANGELOG.md. 
+```
+
+#### Step 2
+
+After merging pull request that was created automatically in step 1, run command in root of repository where `.podspec` is.
+
+```sh
+allegro_release to_master
+```
+
+**What it does?**
+
+1. Checkouts `release_<version>` branch and pulls changes from repository.
+2. Creates pull requests from `release_<version>` to `master`.
+
+#### Step 3
+
+After merging pull request that was created automatically in step 2, run command in root of repository where `.podspec` is.
+
+```sh
+allegro_release finish
+```
+
+**What it does?**
+
+1. Checkouts `master` branch and pulls changes from repository.
+2. Adds tag to `master` with updated version.
+3. Pushes `.podspec` to spec repository (this repository).

data/allegro_release.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency "colorize", '~> 0'
   spec.add_dependency "highline", '~> 1.0'
+  spec.add_dependency "cocoapods", '~> 0.39'
+  spec.add_dependency "atlassian-stash", '~> 0.7'
 end

data/lib/allegro_release.rb

@@ -59,35 +59,51 @@ module AllegroRelease
     end
 
     def self.to_master
-      checkout_develop
+      checkout_release
       create_pull_request_to_master
       puts "Second step is done! Now head to HipChat and paste the content of clipboard that contains link to pull request. After manual merge perform `allegro_release finish`.".colorize(:green)
     end
 
     def self.create_pull_request_to_master
       puts "Creating pull request to master on Stash.".colorize(:green)
-      link = `stash pull-request master -T \"Release #{version_from_file}.\" -d \"Release #{version_from_file}.\"`
+      pull_request_command = "stash pull-request master -T \"Release #{version_from_file}.\" -d \"Release #{version_from_file}.\""
+      link = perform_pull_request(pull_request_command)
       pbcopy "(kotek) (kotek) (successful) (successful) #{link}"
     end
 
     def self.bump(current, next_version, options)
       checkout_develop
-      create_branch(next_version)
+      create_release_branch(next_version)
       replace(current, next_version)
       update_changelog(next_version)
       check_podspec
       commit_release(next_version)
       push_changes_to_remote_branch(next_version)
       create_pull_request_to_develop(next_version)
-      puts "First step is done! Now head to HipChat and paste the content of clipboard that contains link to pull request. After manual merge perform `allegro_release to_master`.".colorize(:green)
+      puts "First step is done! Now head to HipChat and paste the content of clipboard that contains link to pull request. After manual merge perform `allegro_release to_master`.\n".colorize(:green) + "Do not delete local release_#{version_from_file} branch, because it will be used to merge to master branch.".colorize(:red)
     end
 
     def self.create_pull_request_to_develop(version)
       puts "Creating pull request to develop on Stash.".colorize(:green)
-      link = `stash pull-request develop -T \"Release #{version_from_file}.\" -d \"Release #{version_from_file}.\"`
+      pull_request_command = "stash pull-request develop -T \"Release #{version_from_file}.\" -d \"Release #{version_from_file}.\""
+      link = perform_pull_request(pull_request_command)
       pbcopy "(kotek) (kotek) (successful) (successful) #{link}"
     end
 
+    def self.perform_pull_request(pull_request_command)
+      link = `#{pull_request_command}`
+      if link.include? 'Authentication failed. Please check your credentials and try again.'
+        expired_credentials = "Your Stash credentials expired (probably due to monthly password change). Below you can find instruction what values to enter. Authorizing again. \n".colorize(:red)
+        tip_one = "Bitbucket Server Username: <your_username> (go to \"View Profile\" in upper-right corner of Stash)\n".colorize(:green)
+        tip_two = "Bitbucket Server Password (optional): <your_password>\n".colorize(:green)
+        tip_three = "Bitbucket Server URL: https://stash.allegrogroup.com/\n".colorize(:green)
+        puts expired_credentials + tip_one + tip_two + tip_three
+        system_cmd("stash configure")
+        link = `#{pull_request_command}`
+      end
+      return link
+    end
+
     def self.push_changes_to_remote_branch(version)
       puts "Pushing branch to upstream.".colorize(:green)
       system_cmd("git push -u origin release_#{version}")
@@ -143,6 +159,14 @@ module AllegroRelease
       system_cmd("git pull")
     end
 
+    def self.checkout_release
+      return unless File.directory?(".git")
+      puts "Pulling release_#{version_from_file} branch.".colorize(:green)
+      system_cmd("git checkout release_#{version_from_file}")
+      system_cmd("git pull")
+      puts "Checking out release_#{version_from_file} branch.".colorize(:green)
+    end
+
     def self.commit(jira_id, version)
       return unless File.directory?(".git")
       commit_message = "'[#{jira_id}] Release #{version}.'"
@@ -151,7 +175,7 @@ module AllegroRelease
       system_cmd("git commit -m #{commit_message}")
     end
 
-    def self.create_branch(version)
+    def self.create_release_branch(version)
       return unless File.directory?(".git")
       puts "Creating release branch.".colorize(:green)
       system_cmd("git checkout -b release_#{version}")

data/lib/allegro_release/version.rb

@@ -1,3 +1,3 @@
 module AllegroRelease
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allegro_release
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Aleksander Grzyb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: atlassian-stash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: A command line tools to release module easily.
 email:
 - aleksander.grzyb@allegrogroup.com
@@ -103,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A command line tools to release module.