verto 0.10.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e25eb48e99ebcf8a694fb9dd2756a302828612b4d514a16a5e81c06dcbaf2385
-  data.tar.gz: 0d67ea5fd94568c7ef881da2b0348f76b095c3c3234d08e60cfaf2c3a0b4ba03
+  metadata.gz: 2e47505134ac4ade2dacefc6a709c60248906b0ca224845c2fa7c1942e295644
+  data.tar.gz: d3bfb3305978744b7d7be5f33c9b2ee58ddbf3c495518e49e8b8e8923937bd25
 SHA512:
-  metadata.gz: 7fc4713f280b30ca32ba53331af2749899034f480cb8779562c5a3d90325cd70aee6790e2727ecc1ade83f38eb8ee85930e614fcc5e0b23f09ed630f2a0cfb62
-  data.tar.gz: 46f4ca5659357051ce2d981638af8ea75856b701e8e1570f0840d3de4f39845e4cf3c5aaddd58cdb157a0547af524bc30cefe2814fad1f57e25acee5aa64d763
+  metadata.gz: 34f25e60110e798d56981f11a15fa49b06b2f1e80ecdcf0203465ac4ca273a53ed2d52af51f99fc717c2feb50af2cfadaa16ca551590d684b451fa526e40d9d0
+  data.tar.gz: b82da002e1d630babd7a692fcedb8a9dfa031379850f87cd27657348c41ebc961a8e30780b1f683619d2eebf6a25e961f3856aa075e356b38654c6c1059a53a0

data/.github/workflows/ruby.yml

@@ -4,7 +4,7 @@ on: [push]
 
 jobs:
   build:
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-18.04
     strategy:
       matrix:
         ruby: ['2.5', '2.6', '2.7', '3.0']
@@ -38,14 +38,17 @@ jobs:
           ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}
 
   lint:
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-18.04
     name: Lint
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: '2.5'
-      - run: |
+      - name: Install Gems
+        run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
+      - name: Running Rubocop
+        run: |
           bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.12.0 - 28/10/2021
+ * [DOC] Add Verto Syntax Documentation
+ * [FEATURE] Add option to edit the CHANGELOG
+ * [FEATURE] Add update_changelog strategies
+ * [TECH] Configure pry and pry-byebug
+
+## 0.11.0 - 16/04/2021
+ * [FEATURE] Adds fetch_before_tag_creation built-in hook
+ * [FEATURE] Verto Tag Init Command
+
 ## 0.10.2 - 23/02/2021
  * [TECH] Adds Ruby 3 in Github Actions
  * [FIX] Update Changelog Typo

data/Gemfile.lock

@@ -1,41 +1,54 @@
 PATH
   remote: .
   specs:
-    verto (0.10.2)
-      dry-auto_inject (~> 0.7)
-      dry-configurable (~> 0.8)
-      dry-container (~> 0.7)
+    verto (0.12.0)
+      dry-auto_inject (~> 0.7.0)
+      dry-configurable (~> 0.9.0)
+      dry-container (~> 0.7.0)
+      dry-core (~> 0.6.0)
       mustache (~> 1.1.1)
       thor (~> 1.0.1)
+      tty-editor (~> 0.7.0)
+      tty-prompt (~> 0.23.1)
       vseries (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    byebug (11.1.1)
-    concurrent-ruby (1.1.8)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.4.0)
     dry-auto_inject (0.7.0)
       dry-container (>= 0.3.4)
-    dry-configurable (0.12.1)
+    dry-configurable (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
+      dry-core (~> 0.4, >= 0.4.7)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+    dry-core (0.6.0)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
+    json (2.6.1)
+    method_source (1.0.0)
     mustache (1.1.1)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -49,26 +62,39 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (0.93.1)
+    rubocop (1.22.2)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.8.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (1.0.1)
-    unicode-display_width (1.7.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-editor (0.7.0)
+      tty-prompt (~> 0.22)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.1.0)
     vseries (0.2.0)
+    wisper (2.0.1)
 
 PLATFORMS
   ruby
@@ -76,6 +102,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   byebug
+  pry-byebug (~> 3.9.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
@@ -83,4 +110,4 @@ DEPENDENCIES
   verto!
 
 BUNDLED WITH
-   2.2.3
+   2.2.24

data/README.md

@@ -4,58 +4,14 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/39e7c6f1f5f57b8555ed/test_coverage)](https://codeclimate.com/github/catks/verto/test_coverage)\
 Verto is a CLI to generate git tags (following the [Semantic Versioning](https://semver.org/) system)
 
-## Installation
-
-
-### Ruby Gem
-Verto is distributed as a ruby gem, to install run:
-
-```shell
-$ gem install verto
-```
-
-### With Rbenv
-
-If you use Rbenv you can install verto only once and create a alias in your .basrc, .zshrc, etc:
-
-#### ZSH
-    $ RBENV_VERSION=$(rbenv global) gem install verto && echo "alias verto='RBENV_VERSION=$(rbenv global) verto'" >> ~/.zshrc
-
-#### Bash
-    $ RBENV_VERSION=$(rbenv global) gem install verto && echo "alias verto='RBENV_VERSION=$(rbenv global) verto'" >> ~/.bashrc
-
-
-### Docker Image
-
-You don't need to install verto in your machine, you can run verto via the docker image
-
-To use verto in the same way that you use any other cli, you can set an alias in your `.bashrc`, `.zshrc`, etc:
-
-```shell
-alias verto='docker run --rm -v $(pwd):/usr/src/project -it catks/verto:0.10.2'
-```
-
-If you want you can share your git configuration and known_hosts with:
-
-```shell
-alias verto='docker run --rm -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -it catks/verto:0.10.2'
-
-```
-
-You can also use your ssh keys, know_hosts and git config with verto container (for git push):
-
-```shell
-alias verto='docker run --rm -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa -e SSH_PRIVATE_KEY=/root/.ssh/id_rsa -it catks/verto:0.10.2'
-
-```
-
-Now you can run any verto command! :)
 
 ## Usage
 
 You can run verto right out of the box without any configuration:
 
 ```shell
+  verto tag init # Creates the initial tag (0.1.0) if the repository doesn't have tags
+
   verto tag up --patch # Creates a new tag increasing the patch number
   verto tag up --minor # Creates a new tag increasing the minor number
   verto tag up --major # Creates a new tag increasing the major number
@@ -85,12 +41,13 @@ You can create a new Vertofile with `verto init` or following the next example:
 ```ruby
 # Vertofile
 
-verto_version '0.10.2'
+verto_version '0.12.0'
 
 config {
  # version.prefix = 'v' # Adds a version_prefix
- # pre_release.default_identifier = 'alpha' } # Defaults to 'rc'
+ # pre_release.default_identifier = 'alpha' # Defaults to 'rc'
  git.pull_before_tag_creation = true # Pull Changes before tag creation
+ git.fetch_before_tag_creation = true # Fetch Branches and Tags before tag creation
  git.push_after_tag_creation = true # Push changes after tag creation
 
  ## CHANGELOG FORMAT
@@ -160,7 +117,53 @@ context(!branch('master', 'staging')) {
 
 #### Verto Syntax
 
-...TODO...
+[See more details here](VERTO_SYNTAX.md)
+
+## Installation
+
+### Ruby Gem
+Verto is distributed as a ruby gem, to install run:
+
+```shell
+$ gem install verto
+```
+
+### With Rbenv
+
+If you use Rbenv you can install verto only once and create a alias in your .basrc, .zshrc, etc:
+
+#### ZSH
+    $ RBENV_VERSION=$(rbenv global) gem install verto && echo "alias verto='RBENV_VERSION=$(rbenv global) verto'" >> ~/.zshrc
+
+#### Bash
+    $ RBENV_VERSION=$(rbenv global) gem install verto && echo "alias verto='RBENV_VERSION=$(rbenv global) verto'" >> ~/.bashrc
+
+
+### Docker Image
+
+You don't need to install verto in your machine, you can run verto via the docker image
+
+To use verto in the same way that you use any other cli, you can set an alias in your `.bashrc`, `.zshrc`, etc:
+
+```shell
+alias verto='docker run --rm -v $(pwd):/usr/src/project -it catks/verto:0.12.0'
+```
+
+If you want you can share your git configuration and known_hosts with:
+
+```shell
+alias verto='docker run --rm -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -it catks/verto:0.12.0'
+
+```
+
+You can also use your ssh keys, know_hosts and git config with verto container (for git push):
+
+```shell
+alias verto='docker run --rm -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa -e SSH_PRIVATE_KEY=/root/.ssh/id_rsa -it catks/verto:0.12.0'
+
+```
+
+Now you can run any verto command! :)
 
 ## TODO
 

data/Rakefile

@@ -3,7 +3,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require_relative 'lib/verto'
-require_relative 'spec/helpers/test_repo.rb'
+require_relative 'spec/helpers/test_repo'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/VERTO_SYNTAX.md

@@ -0,0 +1,350 @@
+# Verto Syntax
+
+## verto_version
+
+Set the minimal verto version compatible with Vertofile
+
+```ruby
+# Vertofile
+verto_version '0.11.0'
+```
+
+## config
+
+Allows you to  customize the behavior for verto commands.
+
+Example:
+```ruby
+# Vertofile
+config {
+ version.prefix = 'v' # Adds a version_prefix
+ pre_release.default_identifier = 'alpha' # Defaults to 'rc'
+ git.pull_before_tag_creation = true # Pull Changes before tag creation
+ git.fetch_before_tag_creation = true # Fetch Branches and Tags before tag creation
+ git.push_after_tag_creation = true # Push changes after tag creation
+
+ ## CHANGELOG FORMAT
+ ## Verto uses Mustache template rendering to render changelog updates, the default value is:
+ ##
+ ##   ## {{new_version}} - #{Time.now.strftime('%d/%m/%Y')}
+ ##       {{#version_changes}}
+ ##       * {{.}}
+ ##       {{/version_changes}}
+ ##
+ ## A custom format can be specified, eg:
+ changelog.format =  <<~CHANGELOG
+                        ## {{new_version}}
+                         {{#version_changes}}
+                         * {{.}}
+                         {{/version_changes}}
+                     CHANGELOG
+}
+
+```
+
+## context
+
+In the context block you can create a scope that will only run if the statment it's true.
+
+Example:
+
+```ruby
+# Vertofile
+
+# Only runs on master branch
+context(branch('master')) {
+...
+}
+
+# Only runs on staging branch
+context(branch('staging')) {
+...
+}
+# Only runs if the branch is not master or staging
+context(!branch('master', 'staging')) {
+...
+}
+
+# You can also run with a custom conditional (With ruby code)
+context(current_branch.match?(/feature\/.+/)) {
+...
+}
+```
+
+## before
+
+Runs before executing a verto command
+
+```ruby
+# Vertofile
+
+before {
+ puts "Before a command"
+}
+context(branch('master')) {
+	before {
+	 puts "Before a command in master branch"
+	}
+}
+```
+## after
+Runs after executing a verto command
+
+Example:
+```ruby
+# Vertofile
+
+after {
+ puts "After a command"
+}
+context(branch('master')) {
+	before {
+	 puts "After a command in master branch"
+	}
+}
+```
+
+## before_command_tag_up
+
+Almost the same as before but run before the tag creation, the new tag can be accessible with as `new_version`
+
+Example:
+```ruby
+# Vertofile
+
+before_tag_creation {
+     puts "New version is #{new_version}"
+     ...
+}
+```
+
+## after_command_tag_up
+
+The same as before_command_tag_up but run after the tag creation, the new tag can be accessible with as `new_version`
+
+Example:
+```ruby
+# Vertofile
+
+after_tag_creation {
+     puts "New version is #{new_version}"
+     ...
+}
+```
+
+## command_options
+
+Allows you to set a specific option without the need to pass it explicity in the verto command (See `verto tag up --help` to see the options).
+
+Example:
+```ruby
+# Vertofile
+
+context(branch('master')) {
+  before_command_tag_up {
+    command_options.add(filter: 'release_only')
+  }
+  ...
+}
+
+context(branch('staging')) {
+  before_command_tag_up {
+    command_options.add(pre_release: 'rc')
+  }
+  ...
+}
+```
+
+## update_changelog
+
+Start a flow to update the changelog (must be in `before_command_tag_up` or  `after_command_tag_up)`
+
+Options include:
+
+* `:merged_pull_requests_with_bracketed_labels`: Uses all PR merged commits after the last tag if they have the [***] pattern
+* `:commits_with_bracketed_labels` : Uses all commits after the last tag if they have the [***] pattern (Exclude merge commits)
+* `:merged_pull_requests_messages` : Uses all merged commit after the last tag
+* `:commit_messages`: Uses all commits after the last tag (Exclude merge commits)
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+     update_changelog(with: :merged_pull_requests_with_bracketed_labels,
+                      confirmation: true, # Asks for confirmation (you can also edit the generated CHANGELOG)
+                      filename: 'CHANGELOG.md')
+     git('add CHANGELOG.md')
+
+     git('commit -m "Updates CHANGELOG"')
+  }
+}
+...
+```
+
+## file
+
+Allows you to do some operations in a specific file.
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+      file('package.json').replace(/"(\d+)\.(\d+)\.(\d+)(-?.*)"/, %Q{"#{new_version}"})
+      git!('add package.json')
+
+      file('README.md').replace_all(latest_version.to_s, new_version.to_s)
+      git!('add README.md')
+      git!('commit -m "Bumps Version"')
+
+	  file('versions_asc').append("#{new_version} - #{Time.now}")
+	  file('versions_desc').prepend("#{new_version} - #{Time.now}")
+    }
+  }
+...
+```
+
+## env
+
+Allows you to access a specifc environment variable
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('staging')) {
+  before_tag_creation {
+	  file('ci.log').append(env('CI_WORKER'))
+	  ...
+    }
+  }
+...
+```
+
+## confirm
+
+Ask for confirmation before executing anything
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+	  confirm('Are you sure?')
+	  ...
+    }
+  }
+...
+```
+
+## error
+
+Sends an error to **stderr**
+
+Example:
+```ruby
+# Vertofile
+...
+context(!branch('master')) {
+   error('Not at master')
+}
+...
+```
+
+## error!
+
+The same as error but exits verto (without creating a tag)
+
+Example:
+```ruby
+# Vertofile
+...
+context(!branch('master')) {
+   error!('Not at master')
+}
+...
+```
+
+## sh
+
+Runs any shell command.
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+      ...
+      sh('bundle install')
+      sh('rake install')
+      git!('add Gemfile.lock')
+
+      git!('commit -m "Bumps Version"')
+    }
+  }
+...
+```
+
+## sh!
+
+The same as sh but exits verto in case of errors
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+      ...
+      sh!('bundle install')
+      sh!('rake install')
+      git!('add Gemfile.lock')
+
+      git!('commit -m "Bumps Version"')
+    }
+  }
+...
+```
+
+## git
+
+Runs git commands in verto
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+      ...
+      update_changelog
+      git('add CHANGELOG.md')
+      git('commit -m "Bumps Version"')
+    }
+  }
+...
+```
+
+## git!
+
+The same as **git** but exits verto in case of errors
+
+Example:
+```ruby
+# Vertofile
+...
+context(branch('master')) {
+  before_tag_creation {
+      ...
+      update_changelog
+      git!('add CHANGELOG.md')
+      git!('commit -m "Bumps Version"')
+    }
+  }
+...
+```

data/Vertofile

@@ -1,4 +1,4 @@
-verto_version '0.10.2'
+verto_version '0.12.0'
 
 config {
   version.prefix = 'v' # Adds a version_prefix

data/bin/console

@@ -7,9 +7,5 @@ require 'verto'
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)
+require 'pry'
+Pry.start