gotsha 0.3.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcd97adf3389ca91dd4a960d384481f31846423bf51eac8ecda8cf4634d8eb8
-  data.tar.gz: f59e613178b3708fe10ea46ec5367459185a3c1786dbad66fb84835ba789e016
+  metadata.gz: 16232c9b98aaded3d2b891cd656535e6bf459ca38d54713d02ff99edb30a315f
+  data.tar.gz: 3b2fa2a182a012259a8e6580904c4fbbe6ed4d46c2e92c9b29d0b2fbe5073711
 SHA512:
-  metadata.gz: e5cd691e9c3b94e53d4f2772f06716423d941909a65ff21a2a662ef149d2436a70c6af3d6afceca7329f9ad17f30feadccb49ed07034cf02838c6d292f13e0fa
-  data.tar.gz: c9b1fceb52dc6f154cc65d19b6e8fc0fc97128092c2f10b0de96c41844901c491e33c5ccd861bd0b521ec9bf12f22047b44239bf146d6e662faaf5bf1f9ff33d
+  metadata.gz: 43f2104554585f96fa39e4554478322bc754dd556ff763652a476a9a18833652a6656da00377559487aa1a25ad4022132bef82496768c1d1754b5e20b2d3ed6e
+  data.tar.gz: c46031edc29d263cebab3c7bfd3108187e7d3aae9e261ef22ecc5631956134fef27518f98175c2bf72953597ef7b08b62733a3b2a5ed8b3119b66e885fdfecd9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.0.1] - 2025-10-19
+
+- Fix a bug, happening on first push in a new repository.
+
+## [1.0.0] - 2025-10-19
+
+- Polish the readme.
+
 ## [0.3.1] - 2025-10-18
 
 - Add some non-Ruby test command examples to autogenerated config file. Gotsha is language-agnostic :-).

data/lib/gotsha/actions/commit.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Commit
-      DESCRIPTION = "creates a dummy commit and runs tests on it (use for manual sign-off, if you disable hooks)"
+      DESCRIPTION = "runs tests on a dummy commit for manual sign-off"
 
       def call
         BashCommand.silent_run!('git -c core.hooksPath=/dev/null commit --allow-empty -m "Run Gotsha"')

data/lib/gotsha/actions/configure.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Configure
-      DESCRIPTION = "opens Gotsha config file"
+      DESCRIPTION = "opens Gotsha config (all your tests and their autorun conditions are configured there)"
 
       def call
         editor = ENV["EDITOR"]

data/lib/gotsha/actions/help.rb

@@ -6,20 +6,36 @@ module Gotsha
       DESCRIPTION = "shows available commands and some tips (has optional <COMMAND> argument)"
       INTERNAL_ACTIONS = %i[fetch push test].freeze
 
+      INTERNAL_COMMAND_WARNING =
+        "[WARNING] This is an internal command; if everything works as intended, you should not need to run it"
+
       def call(action_name = nil)
         @action_name = action_name
 
         [
           "help",
           commands,
+          general_description,
+          internal_command_warning,
           action_description,
+          workflows_example,
           config_file,
           contact
-        ].compact.join("\n\n")
+        ].compact.join("\n\n\n")
       end
 
       private
 
+      def general_description
+        return if @action_name
+
+        "About:\n" \
+        "Gotsha is a tiny local CI tool — it runs your tests locally, automatically stores the " \
+        "results as Git notes, and shows them right in your GitHub PR. You don’t need " \
+        "to change your workflow: just use `git commit` and `git push` as usual; Gotsha takes care of the rest.\n" \
+        "https://www.gotsha.org/"
+      end
+
       def commands
         return if @action_name
 
@@ -33,7 +49,7 @@ module Gotsha
           "gotsha #{name}   # #{description}"
         end.compact.sort.join("\n")
 
-        "Available commands: \n\n#{commands}\n"
+        "Available commands:\n#{commands}"
       end
 
       def action_description
@@ -46,17 +62,40 @@ module Gotsha
         raise Errors::HardFail, "unknown command `#{@action_name}`"
       end
 
+      def internal_command_warning
+        return unless @action_name
+        return unless INTERNAL_ACTIONS.include?(@action_name.to_sym)
+
+        INTERNAL_COMMAND_WARNING
+      end
+
+      def workflows_example
+        return if @action_name
+
+        [
+          "Typical workflows (and their setting in config file):",
+          "1. Super-fast tests (few seconds): run them automatically on every commit and push",
+          "- `post_commit_tests = true`",
+          "- `pre_push_tests = true`\n",
+          "2. Slower but still fast (tens of seconds): run them automatically on every push, but not on each commit",
+          "- `post_commit_tests = false`",
+          "- `pre_push_tests = true`\n",
+          "3. Even slower (or just annoying) tests: run them manually with `gotsha commit` command, right before " \
+          " asking for review. Don’t allow any autorun",
+          "- `post_commit_tests = false`",
+          "- `pre_push_tests = false`\n"
+        ].join("\n")
+      end
+
       def config_file
         return if @action_name
 
         [
-          "Config file:",
-          "How and when Gotsha runs tests is configured in `#{Config::CONFIG_FILE}` file, " \
-          "so it's the most important file to check and understand! Luckily, it's brief " \
-          "and contains explaining comments. If you deleted the comments it was originally " \
-          "generated with, or you're not sure how to set it, see " \
-          "https://github.com/melounvitek/gotsha/blob/master/lib/gotsha/templates/config.toml\n"
-        ].join("\n\n")
+          "Original config file:",
+          "If you deleted the explaining comments config file was " \
+          "generated with and something is not clear now, see the original version here: " \
+          "https://github.com/melounvitek/gotsha/blob/master/lib/gotsha/templates/config.toml"
+        ].join("\n")
       end
 
       def contact
@@ -66,7 +105,7 @@ module Gotsha
           "Contact:",
           "Is something not clear? Did you find a bug? Would you use new feature? Let's talk! \n" \
           "Freel free to email me (vitek@meloun.info), or create an issue (https://github.com/melounvitek/gotsha/issues/)"
-        ]
+        ].join("\n")
       end
     end
   end

data/lib/gotsha/actions/push.rb

@@ -9,7 +9,9 @@ module Gotsha
         try_push = push_command
 
         unless try_push.success?
+          puts "First push detected, need to run tests one more time..."
           Fetch.new.call
+          Test.new.call
           push_command
         end
 

data/lib/gotsha/actions/show.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Show
-      DESCRIPTION = "shows last commit test results"
+      DESCRIPTION = "displays full test results for last commit"
 
       def call
         command = BashCommand.silent_run!("git --no-pager notes --ref=gotsha show")

data/lib/gotsha/actions/status.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Status
-      DESCRIPTION = "displays last commit tests status"
+      DESCRIPTION = "returns latest commit tests status (passed / failed / not verified)"
 
       def call
         last_commit_sha = BashCommand.run!("git --no-pager rev-parse HEAD").text_output

data/lib/gotsha/templates/config.toml

@@ -1,9 +1,14 @@
 #
 # Gotsha
 #
+# Original template this file is generated from (in case you deleted some option in your
+# and want to check what it originally looked like):
+# https://github.com/melounvitek/gotsha/blob/master/lib/gotsha/templates/config.toml
+#
 # Start by removing the `autogenerated` line below. While doing that,
 # please, check the rest of this file to configure Gotsha as you need
 #
+#
 autogenerated = true # Remove this line to start using Gotsha
 
 #

data/lib/gotsha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gotsha
-  VERSION = "0.3.1"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotsha
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Vitek Meloun