gotsha 0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2eaa7864b9db6785117da9995761e2f6012ebc0c17d6ea6bd509c36791237e
-  data.tar.gz: d9c634e46197de4fd2c9515bf87ea7fee9f63cceb563dde98068a821e5bab175
+  metadata.gz: b7411287a2f974c217e4cafc5adbb2181d9524ca115e447467d1b9e0ca4731c5
+  data.tar.gz: 848bb1ebec319ef7f118ce40ee975273546b2f69f3d1496dd584645381fc68af
 SHA512:
-  metadata.gz: e97d568ebcd2f288b16841a7a673ad64fe38fcbb6a63ab46acc82ff6601da22891218b9173a325a3ed00cbfe0c27db9247f7ab4590dd1cac7c6b056eabc8857a
-  data.tar.gz: 45bb9f592dc803fbe9d2ce9c4b8e70671d27f92daaeee1c6251b3c83f60f0ce6458b22b2f5bc457c6939504588cfd009b3cb24598a6acc4c0cfca08b57665e79
+  metadata.gz: 83705285475022d4e72b80fa6c55e2344674a4f2112a09848a83d5ddcb5961870b16e822982e25fcf48d8ed8af9c475a8de48feaf815c1a97e6996bad1cda177
+  data.tar.gz: 379693d2f2bbbaf7614101207f4ad0dc2199c02c69d668091a2f6d786c793fa75fd93b85f9780efbbfb0f31040871eb1c9cd7f2824844a31e106c15cd87b62a3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [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 :-).
+
 ## [0.3] - 2025-10-18
 
 - Add guide for case when `gotsha config` fails due to missing `ENV['EDITOR']`

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/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
 
 #
@@ -17,10 +22,11 @@ commands = [
   # Your first test command goes into the parentheses!
   "",
   # See some examples:
-  #  "bundle exec rspec --order rand",
   #  "bin/rails t",
-  #  "rubocop",
-  #  "docker exec -it great-app rspec"
+  #  "docker-compose exec great_app rspec"
+  #  "npm test"
+  #  "npx jest --ci"
+  #  "pytest -q"
 ]
 
 # Git hooks config

data/lib/gotsha/version.rb

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

metadata

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