heal 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284d2d18c3b978e9c3a13c4d08ee21ecca8c3c807d74ae1d605b50786cd116d1
-  data.tar.gz: 2edea805c253d6ac5f3141b2a33d3b7a604c31ffdf34b171067f2f6712d5de28
+  metadata.gz: 7df98db2bf9734c0746ba355d93805baf195a517874f338b23dcc41043f3a55f
+  data.tar.gz: 8c3d7e97f5b79ce75b0ee3176a55cb2afa0b6e465838c0663afadffd1cc9b329
 SHA512:
-  metadata.gz: f0941269ea4162a1f06115776b11c44cac9f82e6453ae63f0798b0e8c4158cf2e767cc76481c76e248f66db42c6bd4d7765ac68607868a31a718d7499adbf15a
-  data.tar.gz: af3dab7f02fdb587d593898d29a9dcc7c2f2d3648c0dbf6469af4c158fc32c20c55f5617054a0eab4166546fbda91e9ad592c3d979925d801e5c59f459655428
+  metadata.gz: d08e1649677f4ec313d2a41a93e62a6d373d7a1d8f59822291e2cf971ab9f5dd5ad46fb02437324805a7d79e20abd1a0e08a62f6b5db95c3899be75577e632d1
+  data.tar.gz: 5519454a9cbb3ef4f9fc2dee54380de79ccd999055a3a43493d437faa4a524653d761b566800302777fc02c569222472b8b42b8eb1c85933ed5fb72d3b491bec

data/README.md

@@ -1,34 +1,132 @@
 # Heal
 
-TODO: Delete this and the text below, and describe your gem
-
-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/heal`. To experiment with that code, run `bin/console` for an interactive prompt.
+Heal is a command-line interface for managing Git workflows and configurations.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+To install the Heal CLI, follow these steps:
+
+1. **Add the gem to your Gemfile**:
+   ```ruby
+   gem 'heal'
+   ```
+
+2. **Install the gem**:
+   Run the following command in your terminal:
+   ```bash
+   bundle install
+   ```
+
+   If you are not using Bundler, you can install the gem directly:
+   ```bash
+   gem install heal
+   ```
+
+3. **Verify the installation**:
+   After installation, you can verify that the Heal CLI is working by running:
+   ```bash
+   heal help
+   ```
+
+## Available Commands
+
+### Configuration
+
+- **`config`**: 
+  - **Description**: Displays the current configuration settings.
+  - **Usage**: 
+    ```bash
+    heal config
+    ```
+
+### Commands
+
+- **`delivery`**: 
+  - **Description**: Delivers an issue to the test environment by checking out the relevant branches and cherry-picking commits associated with the specified issue ID.
+  - **Usage**: 
+    ```bash
+    heal delivery
+    ```
+
+- **`release`**: 
+  - **Description**: Releases a feature to a production-ready branch by cherry-picking commits from issues under an EPIC.
+  - **Usage**: 
+    ```bash
+    heal release
+    ```
+
+- **`git cherry-pick-pr COMMIT_MESSAGE_IDENTIFIER REPO SOURCE_BRANCH TARGET_BRANCH THROWAWAY_BRANCH`**: 
+  - **Description**: Cherry picks a PR based on a commit message identifier (like a JIRA key), source repository, source branch, target branch, and a throwaway branch used for creating a PR to the target branch.
+  - **Usage**: 
+    ```bash
+    heal git cherry-pick-pr <COMMIT_MESSAGE_IDENTIFIER> <REPO> <SOURCE_BRANCH> <TARGET_BRANCH> <THROWAWAY_BRANCH>
+    ```
+
+- **`git find-commits COMMIT_MESSAGE_IDENTIFIER`**: 
+  - **Description**: Finds commit IDs based on an identifier in the commit message.
+  - **Usage**: 
+    ```bash
+    heal git find-commits <COMMIT_MESSAGE_IDENTIFIER>
+    ```
+
+- **`git create-pr REPO_NAME SOURCE_BRANCH TO_BRANCH`**: 
+  - **Description**: Creates a PR from a source branch to a target branch in the specified repository.
+  - **Usage**: 
+    ```bash
+    heal git create-pr <REPO_NAME> <SOURCE_BRANCH> <TO_BRANCH>
+    ```
+
+## Configuration File
+
+The Heal CLI uses a configuration file to manage settings. By default, the configuration file is located at `~/.heal/config.yml`. You can specify a different path using the `-c` option.
+
+### Configuration Structure
+
+The configuration file should include the following sections:
+
+- **git**: Contains Git-related settings.
+  - **repos**: An array of repository paths that the CLI will manage.
+  - **directories**: An array of directories to search for Git repositories.
+  - **branch**: Contains branch settings.
+    - **prefix**: The prefix for branch names.
+    - **targets**: Specifies target branches for delivery and development.
+
+### Example Configuration
+
+```yaml
+git:
+  repos:
+    - /path/to/repo1
+    - /path/to/repo2
+  directories:
+    - ~/projects
+  branch:
+    prefix: "feature"
+    targets:
+      test: "test-branch"
+      development: "dev-branch"
+      release: "release-branch"
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+To use the Heal CLI, simply run the command followed by the desired subcommand. For example:
 
-## Usage
+```bash
+heal delivery
+```
 
-TODO: Write usage instructions here
+This command will initiate the delivery process for the issue with the ID prompted by the user.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/heal/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/heal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/heal/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/jjatinggoyal/heal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jjatinggoyal/heal/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +134,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Heal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/heal/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Heal project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/jjatinggoyal/heal/blob/master/CODE_OF_CONDUCT.md).

data/build.sh

@@ -1,2 +1,2 @@
 gem build heal.gemspec
-gem install heal-0.0.1.gem
+gem install heal-0.0.2.gem

data/lib/heal/cli/git.rb

@@ -1,45 +1,38 @@
 class Heal::Cli::Git < Heal::Cli::Base
 
-  desc "delivery ISSUE_ID", "Deliver an issue to test environment"
-  def delivery(issue_id)
-    ask_repo_choices.each do |repo|
-      prepare(repo) do
-        checkout_and_pull development_branch(issue_id)
-        commits = issue_commits issue_id
-        checkout_and_pull delivery_branch
-        git :checkout, :"-b", issue_branch(issue_id)
-
-        cherry_pick_commits(commits.reverse)
-        
-        git :push, :origin, :"-f", issue_branch(issue_id)
-        create_pr from: issue_branch(issue_id), to: delivery_branch
-      end
+  desc "cherry-pick-pr COMMIT_MESSAGE_IDENTIFIER REPO SOURCE_BRANCH TARGET_BRANCH THROWAWAY_BRANCH",
+       "Cherry Pick a PR based on a commit message identifier (like jira key), source repository, source branch, target branch and a throwaway branch used for creating PR to target branch"
+  def cherry_pick_pr(commit_message_identifier, repo, source_branch, target_branch, throwaway_branch)
+    prepare repo do
+      checkout_and_pull source_branch
+      commits = invoke "heal:cli:git:find-commits", [commit_message_identifier]
+      checkout_and_pull target_branch
+      checkout_new_branch throwaway_branch
+
+      cherry_pick_commits(commits)
+
+      git :push, :origin, throwaway_branch
+      invoke "heal:cli:git:create-pr", [repo_name, throwaway_branch, target_branch]
     end
   end
 
-  desc "release EPIC_ID", "Release an EPIC to a production ready branch"
-  def release(epic_id)
-
+  desc "find-commits COMMIT_MESSAGE_IDENTIFIER", "Find commit ids based on an identifier in commit message"
+  def find_commits(commit_message_identifier)
+    p `#{git :log, :"--oneline", :"--grep", commit_message_identifier, execute: false}`.lines.map { |line| line.split.first }.reverse
   end
 
-  private
-
-  def ask_repo_choices
-    choices = @config["git"]["repos"].map { |repo| { File.basename(repo) => repo } }
-    PROMPT.multi_select("Choose repositories:", choices, filter: true)
-  end
-
-  def delivery_branch
-    @config["git"]["branch"]["targets"]["test"]
-  end
 
-  def development_branch(issue_id)
-    @config["git"]["branch"]["prefix"] + "/" + @config["git"]["branch"]["targets"]["development"] + "/" + issue_id
+  # Opens a link to create a PR from +source_branch+ to +target_branch+ in +repo_name+
+  #
+  # @param repository_name [String] name of the repository to create the PR in
+  # @param source_branch [String] name of the branch to create the PR from
+  # @param target_branch [String] name of the branch to create the PR to
+  desc "create-pr REPO_NAME SOURCE_BRANCH TO_BRANCH", "Create a PR from a source to a target branch"
+  def create_pr(repository_name, source_branch, target_branch)
+    `open #{format(@config["git"]["pr_link"], repository_name, source_branch, target_branch)}`
   end
 
-  def issue_branch(issue_id)
-    @config["git"]["branch"]["prefix"] + "/" + delivery_branch + "/" + issue_id
-  end
+  private
 
   def prepare(repo_path)
     @path = repo_path
@@ -60,6 +53,35 @@ class Heal::Cli::Git < Heal::Cli::Base
     `#{git :log, :"--oneline", :"--grep", issue_id, execute: false}`.lines.map { |line| line.split.first }
   end
 
+  def checkout_new_branch(throwaway_branch)
+    branch_already_present = (git :"rev-parse", :"--verify", throwaway_branch) || (git :"rev-parse", :"--verify", "origin/#{throwaway_branch}")
+    if branch_already_present
+      git :checkout, throwaway_branch
+    else
+      git :checkout, :"-b", throwaway_branch
+    end
+  end
+
+  def cherry_pick_commits(commits)
+    commits.each do |commit|
+      result = git :"cherry-pick", :"-x", :"--no-merges", commit
+      unless result
+        say "Conflict occurred while cherry-picking commit #{commit}. Please resolve the conflict and press any key to continue.", :red
+
+        loop do
+          # Check if there are unresolved conflicts
+          if `#{git :status, execute: false}`.include?("Unmerged paths")
+            PROMPT.keypress("Please resolve the conflicts and then press any key to continue...", active_color: :red)
+          else
+            say "Conflict resolved. Continuing with cherry-picking.", :green
+            git :"cherry-pick", :"--continue"
+            break # Exit the loop if conflicts are resolved
+          end
+        end
+      end
+    end
+  end
+
   def current_branch
     `#{git :"rev-parse", :"--abbrev-ref", :HEAD, execute: false}`.strip
   end
@@ -74,10 +96,6 @@ class Heal::Cli::Git < Heal::Cli::Base
     false
   end
 
-  def create_pr(from:, to:)
-    `open #{format(@config["git"]["pr_link"], repo_name, from, to)}`
-  end
-
   def repo_name
     `#{git :remote, :"get-url", :origin, execute: false}`.match(/.*\/(.*?)\.git/)[1]
   end
@@ -87,24 +105,4 @@ class Heal::Cli::Git < Heal::Cli::Base
     execute ? system(command) : command
   end
 
-  def cherry_pick_commits(commits)
-    commits.each do |commit|
-      result = git :"cherry-pick", :"-x", :"--no-merges", commit
-      unless result
-        say "Conflict occurred while cherry-picking commit #{commit}. Please resolve the conflict and press any key to continue.", :red
-        
-        loop do
-          # Check if there are unresolved conflicts
-          if `#{git :status, execute: false}`.include?("Unmerged paths")
-            PROMPT.keypress("Please resolve the conflicts and then press any key to continue...", active_color: :red)
-          else
-            say "Conflict resolved. Continuing with cherry-picking.", :green
-            git :"cherry-pick", :"--continue"
-            break # Exit the loop if conflicts are resolved
-          end
-        end
-      end
-    end
-  end
-
 end

data/lib/heal/cli/main.rb

@@ -5,7 +5,57 @@ class Heal::Cli::Main < Heal::Cli::Base
     puts @config.to_yaml
   end
 
+  desc "delivery", "Deliver an issue to test environment"
+  def delivery
+    issue_id = PROMPT.ask("Please enter the Issue key...\n", required: true)
+
+    source_branch = development_branch(issue_id)
+    
+    ask_repo_choices.each do |repo|
+      invoke "heal:cli:git:cherry-pick-pr", [issue_id, repo, source_branch, delivery_branch, issue_branch(issue_id)]
+    end
+  end
+
+  desc "release", "Release a Feature to a production ready branch"
+  def release
+    feature_id = PROMPT.ask("Enter the Feature key...\n", required: true)
+    feature_issues = PROMPT.ask("Enter all issues under the EPIC: JIRA-1,JIRA-2,...\n", required: true, convert: :array)
+    
+    ask_repo_choices.each do |repo|
+      feature_issues.each do |issue_id|
+        invoke "heal:cli:git:cherry-pick-pr", [issue_id, repo, issue_branch(issue_id), release_branch, feature_branch(feature_id)]
+      end
+    end
+  end
+
   desc "git", "Manage Git workflows"
   subcommand "git", Heal::Cli::Git
 
+  private
+
+  def ask_repo_choices
+    choices = @config["git"]["repos"].map { |repo| { File.basename(repo) => repo } }
+    PROMPT.multi_select("Choose repositories:", choices, filter: true)
+  end
+
+  def development_branch(issue_id)
+    @config["git"]["branch"]["prefix"]["test"] + "/" + @config["git"]["branch"]["targets"]["development"] + "/" + issue_id
+  end
+
+  def delivery_branch
+    @config["git"]["branch"]["targets"]["test"]
+  end
+
+  def release_branch
+    @config["git"]["branch"]["targets"]["release"]
+  end
+
+  def issue_branch(issue_id)
+    @config["git"]["branch"]["prefix"]["test"] + "/" + delivery_branch + "/" + issue_id
+  end
+
+  def feature_branch(feature_id)
+    @config["git"]["branch"]["prefix"]["release"] + "/" + feature_id
+  end
+  
 end

data/lib/heal/cli/templates/config.yml

@@ -6,7 +6,9 @@ git:
       development: dev
       test: integration
       release: master
-    prefix: issue
+    prefix:
+      test: issue
+      release: feature
   repos:
     - ~/Projects/enlighten_manager_mvc
   pr_link: https://bitbucket.org/enphaseembedded/%s/pull-requests/new?source=%s&dest=%s/

data/lib/heal/cli.rb

@@ -3,4 +3,4 @@ require "tty-prompt"
 module Heal::Cli
 end
 
-PROMPT = TTY::Prompt.new
+PROMPT = TTY::Prompt.new(interrupt: :exit)

data/lib/heal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heal
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jatin Goyal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor