caretaker 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010b7b56270fe29a13749c4f728c2d329f65ab36c5aea469643d31207e8d941a
-  data.tar.gz: 76a2747db93641034f431dfc622b0e3b44b6919fcdac13e84d93d2025550d31e
+  metadata.gz: 91d5852b415785fdfdea2f0b29be9ff2c082ef674203bbab66f195dacd5634cf
+  data.tar.gz: a0d62be91237cc9f150f0f3751842cb4ea15de729f38880600eb75606928cc48
 SHA512:
-  metadata.gz: 224af39d14ce49161410604d9068a82ca50d1b96327988d4401c5f306839646733c92d246c582dc92ce80b4c2328f759436b8c6669a84191df1b4669c69e7f37
-  data.tar.gz: '086ea81f8f0f443f72a4ea353f05f6968d99b93659af8146f6a76758e2f82aac88c34817114dce7ee74b0825fc75b38e2185b9c7fd465ac434a53860123f3c44'
+  metadata.gz: f701e972ac285d07671cafd4c0c7cc5e149015e2939faef93ee48739797e39f1456ce67c453d2dc76b5f9f8912acd5ff69d2b112f9dd0db0f1f472f443ff4003
+  data.tar.gz: f7ea032712663673eb0fbf536884125363d4bdb0994efc038480ba8b8d1a54dc1ba17648e1158e33bbe681d4267d62fb814e84f574b81e5e9617da91323b83fa

data/.gitignore

@@ -18,3 +18,5 @@ ab-results*
 .rspec_status
 
 .lock
+
+.caretaker.yml

data/CHANGELOG.md

@@ -5,19 +5,41 @@ All notable changes to this project will be documented in this file.
 
 This changelog was automatically generated using [Caretaker](https://github.com/WolfSoftware/caretaker) by [Wolf Software](https://github.com/WolfSoftware)
 
-### [Unreleased](https://github.com/WolfSoftware/caretaker/compare/v0.2.0...HEAD)
+### [v0.5.0](https://github.com/WolfSoftware/caretaker/compare/v0.4.0...v0.5.0)
 
-- Missed the name of the cli options for min-words from -m to -w [`[346ebbc]`](https://github.com/WolfSoftware/caretaker/commit/346ebbc9cb1f08034373b8143436e20cda2d11dd)
+> Released on February, 24th 2020
 
-- Type in the post-commit hook - doesnt stop it working but causes error output [`[9da99cc]`](https://github.com/WolfSoftware/caretaker/commit/9da99cc6b5bc131d491df8019b3acb5dcf62fa6f)
+- Fix an error in the post-commit script where the wrong variable name was being used [`[e0d60a5]`](https://github.com/WolfSoftware/caretaker/commit/e0d60a52e65ceabe8e4adea9ccfe0c295f183f53) [`[TGWolf]`](https://github.com/TGWolf)
+
+### [v0.4.0](https://github.com/WolfSoftware/caretaker/compare/v0.3.0...v0.4.0)
+
+> Released on February, 24th 2020
+
+- Updated version file for push of gem [`[8dfae21]`](https://github.com/WolfSoftware/caretaker/commit/8dfae211ec5ab70477d3d6587d84cc043a790d64) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Fix errors from travis + rubocop [`[5e69549]`](https://github.com/WolfSoftware/caretaker/commit/5e69549506726a8782899d004b64b56ba6fe4729) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Fix some issues raised by shellcheck in the post-commit hook [`[caa33d2]`](https://github.com/WolfSoftware/caretaker/commit/caa33d239b00cbea48f9123177a126cade113fac) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Add new release tagging and version bumping [`[786ed88]`](https://github.com/WolfSoftware/caretaker/commit/786ed88d1bf3486b03fbc2ee755d4ae4c763ab96) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Updated changelog to reflect current version [`[007fa21]`](https://github.com/WolfSoftware/caretaker/commit/007fa219d4845f1910cd625a325574f80909153a) [`[TGWolf]`](https://github.com/TGWolf)
+
+### [v0.3.0](https://github.com/WolfSoftware/caretaker/compare/v0.2.0...v0.3.0)
+
+> Released on February, 10th 2020
+
+- Missed the name of the cli options for min-words from -m to -w [`[2b8e0cf]`](https://github.com/WolfSoftware/caretaker/commit/2b8e0cf79dd8e957aa688b395ab37f165322bd1e) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Type in the post-commit hook - doesnt stop it working but causes error output [`[9da99cc]`](https://github.com/WolfSoftware/caretaker/commit/9da99cc6b5bc131d491df8019b3acb5dcf62fa6f) [`[TGWolf]`](https://github.com/TGWolf)
 
 ### [v0.2.0](https://github.com/WolfSoftware/caretaker/releases/v0.2.0)
 
 > Released on February, 10th 2020
 
-- Had to bump to version 0.2.0 due to a broken push of 0.1.0 [`[c101fb8]`](https://github.com/WolfSoftware/caretaker/commit/c101fb85fa1831b8758bb27944a1693253b1b74f)
+- Had to bump to version 0.2.0 due to a broken push of 0.1.0 [`[c101fb8]`](https://github.com/WolfSoftware/caretaker/commit/c101fb85fa1831b8758bb27944a1693253b1b74f) [`[TGWolf]`](https://github.com/TGWolf)
 
-- Fix an issue with incorrect spinners in the generate config and repo init functions [`[a15b75b]`](https://github.com/WolfSoftware/caretaker/commit/a15b75bae917276c83536b1e7e385c1dfb55f55c)
+- Fix an issue with incorrect spinners in the generate config and repo init functions [`[a15b75b]`](https://github.com/WolfSoftware/caretaker/commit/a15b75bae917276c83536b1e7e385c1dfb55f55c) [`[TGWolf]`](https://github.com/TGWolf)
 
-- Initial push [`[f74a2c4]`](https://github.com/WolfSoftware/caretaker/commit/f74a2c411bf3339410d6a0f59a981abf6286107e)
+- Initial push [`[f74a2c4]`](https://github.com/WolfSoftware/caretaker/commit/f74a2c411bf3339410d6a0f59a981abf6286107e) [`[TGWolf]`](https://github.com/TGWolf)
 

data/README.md

@@ -24,6 +24,7 @@ Caretaker also has an advanced category mode, which allows it to parse specially
 * Automatically linking each pull request to the pull request number.
 * Can run automatically as a post-commit hook.
 * Ignore commits that are shorter than a specified number of words.
+* Bump verions and tag releases automatically.
 
 > For a full list of featues see the section on command line usage.
 
@@ -46,6 +47,9 @@ Caretaker also has an advanced category mode, which allows it to parse specially
           * [Category example](#category-example)
                * [Category list](#category-list)
                * [Example category output](#example-category-output)
+          * [Tagging release versions](#tagging-release-versions)
+               * [Release handler snippet](#release-handler-snippet)
+               * [Bumping release versions](#bumping-release-versions)
           * [Caretaker config file](#caretaker-config-file)
                * [Example config file](#example-config-file)
           * [Github usernames](#github-usernames)
@@ -67,6 +71,7 @@ Caretaker also has an advanced category mode, which allows it to parse specially
      * [Contributing to caretaker](#contributing-to-caretaker)
           * [Setup](#setup)
           * [Testing](#testing)
+* [To-Do List](#to-do-list)
 <!--TOCBot-->
 
 <a name="installation"></a>
@@ -91,6 +96,7 @@ Usage: caretaker [-h] [-a author] [-c] [-e] [-i] [-o filename] [-r] [-s] [-u] [-
 | ------ | ------- |:-------------:|
 | -h or --help | Show the help message | N/A |
 | -a or --author [Github username] | Specify the author name | |
+| -b or --bump [part] | Bump the VERSION.txt to next version. | |
 | -c or --config | Generate a .caretaker.cfg config file. | false |
 | -e or --enable-categories | Enable the splitting of commit messages into categories | false |
 | -i or --init | Initialise the repo to use caretaker | |
@@ -126,8 +132,8 @@ caretaker
 
 res=$(git status --porcelain | grep "${OUTPUT_FILE}" | wc -l)
 if [[ "${res}" -gt 0 ]]; then
-git add "${OUTPUT_FILE}"
-git commit --amend --no-edit
+    git add "${OUTPUT_FILE}"
+    git commit --amend --no-edit
 end
 ```
 
@@ -154,8 +160,8 @@ caretaker -i -e -o HISTORY.md
 
 res=$(git status --porcelain | grep "${OUTPUT_FILE}" | wc -l)
 if [[ "${res}" -gt 0 ]]; then
-git add "${OUTPUT_FILE}"
-git commit --amend --no-edit
+    git add "${OUTPUT_FILE}"
+    git commit --amend --no-edit
 end
 ```
 
@@ -228,6 +234,47 @@ All notable changes to this project will be documented in this file.
 - Created an example without a prefix.
 ```
 
+<a name="tagging-release-versions"></a>
+### Tagging release versions
+
+Due to the way that post-commit hooks work, if you were tag a release that tag would either be ignored or worse lost, because the commit ID changes when a 'commit amend' is carried out. In order to get around this problem Caretaker can now tag releases
+for you as part of its push process.
+
+The current version is stored in 'VERSION.txt', and it is semantic version string (however it can include an optional v prefix eg v1.0.0). This version is used to 'tag' a release as part of the process. It works be comparing the current tag to the
+one in the file and if they are different it will tag the release with the new version.
+
+<a name="release-handler-snippet"></a>
+#### Release handler snippet
+
+The following code is a snippet of how the release mechanism works:
+
+```
+if [[ -n $RELEASE_VERSION ]]; then
+    git tag "${TAG_VERSION}"
+fi
+
+#{cmd}
+
+res=$(git status --porcelain | grep "${OUTPUT_FILE}" | wc -l)
+if [[ "${res}" -gt 0 ]]; then
+    git add "${OUTPUT_FILE}" >> /dev/null 2>&1
+    git commit --amend --no-edit >> /dev/null 2>&1
+
+    if [[ -n "${RELEASE_VERSION"} ]]; then
+        git tag -f "${TAG_VERSION}"
+    fi
+fi
+```
+
+As you can see, it will tag the release, run caretaker and re-tag the release after the commit amend, ensuring that the tag persists. This is not a perfect solution, but it does work :)
+
+<a name="bumping-release-versions"></a>
+#### Bumping release versions
+
+In order to make life as simple as possible the new version of Caretaker comes with a ```--bump``` option, this takes 1 argument of either ```major```, ```minor``` or ```patch``` and will update the version file accordingly.
+
+> Note if the version file doesn't exist, it will be created with a default version of v0.1.0
+
 <a name="caretaker-config-file"></a>
 ### Caretaker config file
 
@@ -387,6 +434,7 @@ For local testing make sure that you run `bundle exec rspec spec` and then `rake
 
 For further information please refer to the [contributing](https://github.com/WolfSoftware/contributing) documentation.
 
+<a name="to-do-list"></a>
 # To-Do List
 
 - [ ] CLI option to enable/disable linking to commit hashes

data/VERSION.txt

@@ -0,0 +1 @@
+0.5.0

data/caretaker.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'date', '~> 2.0.0'
     spec.add_development_dependency 'rake', '~> 10.0'
     spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'sem_version', '~> 2.0.1'
     spec.add_development_dependency 'tty-spinner', '~> 0.9.0'
 
     spec.add_runtime_dependency 'date', '~> 2.0.0'
+    spec.add_runtime_dependency 'sem_version', '~> 2.0.1'
     spec.add_runtime_dependency 'tty-spinner', '~> 0.9.0'
 end

data/exe/caretaker

@@ -16,6 +16,7 @@ def send_message_to_caretaker(options)
         caretaker.init_repo if options[:init]
         caretaker.generate_config_file if options[:config]
         caretaker.generate_changelog if options[:generate]
+        caretaker.bump_version if options[:bump]
     rescue StandardError => e
         puts "Error: #{e}"
         puts e.backtrace
@@ -45,11 +46,26 @@ def process_arguments
             exit(1)
         end
 
-        opts.on('-a', '--author string', 'Specify a default author name to use for commits (author name should be your GIthub username)') do |author|
+        opts.on('-a', '--author string', 'Specify a default author name to use for commits (author name should be your Github username)') do |author|
             options[:author] = author
         end
 
+        opts.on('-b', '--bump string', 'Which part of the version string to bump. (Options: major, minor, patch)') do |bump|
+            valid_bumps = ['major', 'minor', 'patch']
+
+            if valid_bumps.include? bump
+                options[:bump] = bump
+                options[:config] = false
+                options[:generate] = false
+                options[:init] = false
+            else
+                puts "Invalid bump option: #{bump}"
+                abort
+            end
+        end
+
         opts.on('-c', '--config', 'Generate a .caretaker.cfg config file. [default: false]') do
+            options[:bump] = false
             options[:config] = true
             options[:generate] = false
             options[:init] = false
@@ -61,6 +77,7 @@ def process_arguments
         end
 
         opts.on('-i', '--init', 'Initialise the repo to use Caretaker') do
+            options[:bump] = false
             options[:config] = false
             options[:generate] = false
             options[:init] = true

data/lib/caretaker/version.rb

@@ -1,3 +1,3 @@
 class Caretaker
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.5.0'.freeze
 end

data/lib/caretaker.rb

@@ -7,6 +7,9 @@ require 'uri'
 require 'yaml'
 require 'net/http'
 
+require 'sem_version'
+require 'sem_version/core_ext'
+
 #
 # The main caretaker class
 #
@@ -25,6 +28,13 @@ class Caretaker
         @github_base_url = 'https://github.com'
         @spinner_format = :classic
         @header_file = 'HEADER.md'
+        @version_file = 'VERSION.txt'
+        @default_version = '0.1.0'
+        @default_tag_prefix = 'v'
+
+        @bump_major = false
+        @bump_minor = false
+        @bump_patch = false
 
         #
         # Check we are into a git repository - bail out if not
@@ -58,6 +68,9 @@ class Caretaker
         @silent = options[:silent] unless options[:silent].nil?
         @verify_urls = options[:verify_urls] unless options[:verify_urls].nil?
 
+        @bump_major = true unless options[:bump].nil? || options[:bump] != 'major'
+        @bump_minor = true unless options[:bump].nil? || options[:bump] != 'minor'
+        @bump_patch = true unless options[:bump].nil? || options[:bump] != 'patch'
         #
         # Work out the url for the git repository (unless for linking)
         #
@@ -583,26 +596,45 @@ class Caretaker
         contents = <<~END_OF_SCRIPT
 #!/usr/bin/env bash
 
-LOCKFILE="#{@repo_base_dir}/.lock"
+LOCK_FILE="#{@repo_base_dir}/.lock"
+OUTPUT_FILE=#{@output_file}
+VERSION_FILE=#{@version_file}
 
-if [[ -f "${LOCKFILE}" ]]; then
+if [[ -f "${LOCK_FILE}" ]]; then
     exit
 fi
 
-touch "${LOCKFILE}"
+touch "${LOCK_FILE}"
 
-OUTPUT_FILE="#{@output_file}"
+if [[ -f "${VERSION_FILE}" ]]; then
+    RELEASE_VERSION=$(<"${VERSION_FILE}")
+    TAG_NAME="v${RELEASE_VERSION}"
+
+    if GIT_DIR="#{@repo_base_dir}/.git" git tag --list | grep -Eq "^${TAG_NAME}$"; then
+        unset RELEASE_VERSION
+        unset TAG_NAME
+    fi
+fi
+
+if [[ -n "${RELEASE_VERSION}" ]]; then
+    git tag "${TAG_NAME}"
+fi
 
 #{cmd}
 
-res=$(git status --porcelain | grep "${OUTPUT_FILE}" | wc -l)
+res=$(git status --porcelain | grep -c "${OUTPUT_FILE}")
 if [[ "${res}" -gt 0 ]]; then
+
     git add "${OUTPUT_FILE}" >> /dev/null 2>&1
     git commit --amend --no-edit >> /dev/null 2>&1
-fi
 
-rm -f "${LOCKFILE}"
+    if [[ -n "${RELEASE_VERSION}" ]]; then
+        git tag -f "${TAG_NAME}"
+    fi
+
+fi
 
+rm -f "${LOCK_FILE}"
 END_OF_SCRIPT
 
         start_spinner('Writing Hook')
@@ -689,4 +721,60 @@ END_OF_SCRIPT
         write_file("#{@repo_base_dir}/#{@config_file}", content, 0o0644)
         stop_spinner
     end
+
+    #
+    # Bump the version
+    #
+    def bump_version
+        first_version = false
+
+        begin
+            current = File.read(@version_file)
+        rescue SystemCallError
+            puts "failed to open #{@version_file} - Default to version #{@default_version} - will NOT bump version"
+            current = @default_version
+            first_version = true
+        end
+
+        puts "Current Version: #{current}"
+
+        if current.start_with?(@default_tag_prefix)
+            has_prefix = true
+            current.slice!(@default_tag_prefix)
+        end
+
+        begin
+            v = SemVersion.new(current)
+        rescue ArgumentError
+            puts "#{current} is not a valid Semantic Version string"
+            return
+        end
+
+        if @bump_major && !first_version
+            v.major += 1
+            v.minor = 0
+            v.patch = 0
+        end
+
+        if @bump_minor && !first_version
+            v.minor += 1
+            v.patch = 0
+        end
+
+        v.patch += 1 if @bump_patch && !first_version
+
+        version = if has_prefix
+                      "#{@default_tag_prefix}#{v}"
+                  else
+                      v.to_s
+                  end
+
+        puts "New Version: #{version}"
+
+        begin
+            File.write(@version_file, version)
+        rescue SystemCallError
+            puts "Count not write #{VERSION_FILE} - Aborting"
+        end
+    end
 end

data/testing/caretaker

@@ -19,6 +19,7 @@ def send_message_to_caretaker(options)
         caretaker.init_repo if options[:init]
         caretaker.generate_config_file if options[:config]
         caretaker.generate_changelog if options[:generate]
+        caretaker.bump_version if options[:bump]
     rescue StandardError => e
         puts "Error: #{e}"
         puts e.backtrace
@@ -48,11 +49,26 @@ def process_arguments
             exit(1)
         end
 
-        opts.on('-a', '--author string', 'Specify a default author name to use for commits (author name should be your GIthub username)') do |author|
+        opts.on('-a', '--author string', 'Specify a default author name to use for commits (author name should be your Github username)') do |author|
             options[:author] = author
         end
 
+        opts.on('-b', '--bump string', 'Which part of the version string to bump. (Options: major, minor, patch)') do |bump|
+            valid_bumps = ['major', 'minor', 'patch']
+
+            if valid_bumps.include? bump
+                options[:bump] = bump
+                options[:config] = false
+                options[:generate] = false
+                options[:init] = false
+            else
+                puts "Invalid bump option: #{bump}"
+                abort
+            end
+        end
+
         opts.on('-c', '--config', 'Generate a .caretaker.cfg config file. [default: false]') do
+            options[:bump] = false
             options[:config] = true
             options[:generate] = false
             options[:init] = false
@@ -64,6 +80,7 @@ def process_arguments
         end
 
         opts.on('-i', '--init', 'Initialise the repo to use Caretaker') do
+            options[:bump] = false
             options[:config] = false
             options[:generate] = false
             options[:init] = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caretaker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sem_version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: sem_version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +162,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- VERSION.txt
 - bin/console
 - bin/setup
 - caretaker.gemspec