neetob 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129689cbd6ed773bb8b33aced3e726123662c5cc772c52287a3464bf63fe324b
-  data.tar.gz: ea5801918efe691ab99c985315fded011149eab7dc0082481d4c6ce6f41c2594
+  metadata.gz: c24a5c688914c96c2ab4652e673124a9f794e1cdb57ca86e606e61134717b015
+  data.tar.gz: b66c79be8be99068e154fdd811556fa3a6dc947f9f8ac232fdc82654241236b5
 SHA512:
-  metadata.gz: 6e933f42dc569195d856c707ac01911e71538057afcd4d447ab50242330a498d2fb31f769f1375a03bd3fbbad0e105dd24094ad642e74ed2cea0fdf751b5c5e4
-  data.tar.gz: 8a543540b8974374280c0b2781b99c7819918d34c0248b53dd85d0792d05004b4de407717d5bbd3a87881604672d1c714b11986f6642efb1af360a0952bb34e6
+  metadata.gz: d07b6d3b394a6ce90d6feaa8031c506bb49be5bdcf076761cdc1c55b9e555400cc9fafdb766816de82d4bfbc438e8e8a3784c9c2c94d4ab49a3c66795f5f4da0
+  data.tar.gz: 8fbfe0585f64116cd3404873d19a7518e034ffe250d789c5775bc6186c808bcf88c1407e10cbca5c73fe1333ef069642095577c3142054ef2fc6260cd90ee33b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+### [0.3.1](https://www.github.com/bigbinary/neetob/compare/v0.3.0...v0.3.1) (2023-03-23)
+
+
+### Bug Fixes
+
+* Cleanup documentation ([#226](https://www.github.com/bigbinary/neetob/issues/226)) ([c20203b](https://www.github.com/bigbinary/neetob/commit/c20203bf31b0a08e9d22d8cb32295e840c3a1afe))
+
 ## [0.3.0](https://www.github.com/bigbinary/neetob/compare/v0.2.7...v0.3.0) (2023-03-23)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neetob (0.3.0)
+    neetob (0.3.1)
       dotenv (~> 2.8.1)
       launchy (~> 2.5.0)
       octokit (~> 4.0)

data/README.md

@@ -6,8 +6,7 @@ The `neetob` gem gives a different set of commands for interacting with Github r
 
 1. [Usage](#usage)
    1. [Installing neetob for use](#installing-neetob-for-use)
-   2. [For development](#for-development)
-   3. [Gem release](#gem-release)
+   2. [Installing neetob for development](docs/development.md)
 2. [Source of truth](#source-of-truth)
 3. [Working with GitHub](#working-with-github)
    1. [Issues](#issues)
@@ -17,7 +16,7 @@ The `neetob` gem gives a different set of commands for interacting with Github r
    5. [Make PR](#make-pr)
    6. [Gems](#gems)
    7. [Login](#login)
-5. [Working with Heroku](#working-with-heroku)
+4. [Working with Heroku](#working-with-heroku)
    1. [Config Vars](#config-vars)
    2. [Access](#access)
    3. [Execute](#execute)
@@ -27,7 +26,7 @@ The `neetob` gem gives a different set of commands for interacting with Github r
 6. [Make Repos Uptodate](#make-repos-uptodate)
 7. [Working with local Repos](#working-with-local-repos)
    1. [ls](#ls)
-8. [Testing](#testing)
+8. [Testing](docs/testing.md)
 
 ## Usage
 
@@ -67,61 +66,6 @@ Options:
 
 The commands within `neetob` should be used with caution, as improper usage may result in unintended consequences, and some actions may not be reversible. By default, all commands will be executed in non-sandbox mode.
 
-### For development
-
-Clone the repository onto your system using the following command:
-
-```sh
-git clone https://github.com/bigbinary/neetob.git
-```
-
-Navigate to the root of the application directory.
-
-```sh
-cd neetob
-```
-
-To check and use the latest changes in the local repository install `neetob` like so:
-
-```sh
-bin/setup
-```
-
-We can use, check or debug the `neetob` locally by directly invoking the `neetob` class like so:
-
-```sh
-ruby exe/neeetob
-```
-
-#### Conventional commit messages
-
-In `neetob` we are using the Google's [release please](https://github.com/googleapis/release-please) Github action to auto update the version and release the latest gem.
-
-In order to make this action work we have to use the [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
-
-The Conventional commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history.
-
-Generally, we use three types of suffix in the commit messages that are as follows:
-
-1. `fix:` for the commit that fixes a bug in the codebase. This updates the third digit in the version. For example, `0.1.0` version will be updated to `0.1.1`.
-
-2. `feat:` for the commit that introduces a new feature to the codebase. This updates the second digit in the version. For example, `0.1.0` version will be updated to `0.2.0`.
-
-3. `BREAKING CHANGE:` for the commit that introduces a breaking API change. This updates the first digit in the version. For example, `0.1.0` version will be updated to `1.0.0`.
-
-For more details please refer [official docs](https://www.conventionalcommits.org/en/v1.0.0/) from Conventional commits.
-
-In `neetob` we use "squash and merge" option while merging the PR. So we have to update the commit message while squash and merge so that Github action can track that merge commit.
-
-For example:
-
-![Commit message update](images/commit-message-update.png)
-
-
-### Gem release
-
-When a commit is added to the `main` branch [release](.github/workflows/release.yml) Github action checks that commit for the [conventional commit message](#conventional-commit-messages). If a proper suffix like `fix:`, `feat:`, etc is used in that commit message then the Github action will create a new PR with the updated version and changelog. The version and changelog for the `neetob` gem are updated automatically by the Github action using the commit message. When we merge this newly created PR by the Github action into the main branch, an updated Gem is released to the [rubygems](https://rubygems.org).
-
 ## Source of truth
 
 This [list of repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json) is used as the "source of truth".
@@ -178,10 +122,10 @@ neetob github labels show --name priority --repos "neeto-*-staging"
 
 # Changes the name of the label
 neetob github labels update --old-name "High Priority" --new-name \
-"high-priority" --all-neeto-repos
+"high-priority" --repos "all"
 
 # Updates and inserts all the labels mentioned in the file "data/github-labels.json"
-neetob github labels upsert --all-neeto-repos
+neetob github labels upsert --repos "all"
 
 # Accepts a different JSON file using `path` option
 neetob github labels upsert --path ~/Desktop/labels.json --repos "neeto-*-staging"
@@ -189,7 +133,7 @@ neetob github labels upsert --path ~/Desktop/labels.json --repos "neeto-*-stagin
 # Upsert a single label using `name`, `color`, and `description` options
 # No `#` is required while adding `color`
 neetob github labels upsert --name UI --color 8250df --description \
-"UI work needed" --all-neeto-repos
+"UI work needed" --repos "all"
 
 # Deletes the given labels from the Github repos
 neetob github labels delete --labels "High Priority" "Priority 1" "bug" \
@@ -248,13 +192,13 @@ neetob github protect_branch --branch main --path ~/Desktop/branch-protection-ru
 --repos "neeto-*-staging"
 ```
 
-We can also use the `--all-neeto-repos` option with the above mentioned command so that the
+We can also pass the value `all` to the option `--repos` with the above mentioned command so that the
 branch protection rules can be updated for
 all [neeto repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json).
 
 ```sh
 neetob github protect_branch --branch main --path ~/Desktop/branch-protection-rules.json \
---all-neeto-repos
+--repos "all"
 ```
 
 **Note:** Unfortunately, utilizing the Github API, we are unable to update the `Require deployments to succeed before merging` rule, as it is currently not defined as a parameter within the API. For further information on available options to update different branch protection rules, kindly refer to the official Github [documentation](https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection).
@@ -432,8 +376,8 @@ neetob users commits --author udai1931 --duration 6.months
 # List commits for a specific product using `--apps` option
 neetob users commits --author udai1931 --duration 6.months --apps neeto-kb-web
 
-# List commits for all neeto repos using the `--all-neeto-repos` option
-neetob users commits --author udai1931 --duration 6.months --all-neeto-repos
+# List commits for all neeto repos by passing the value `all` to`--apps` option
+neetob users commits --author udai1931 --duration 6.months --apps "all"
 ```
 
 ## Make Repos Uptodate
@@ -443,8 +387,9 @@ The `make_repos_uptodate` command updates all neeto repos.
 ```sh
 neetob make_repos_uptodate
 
-# Update all neeto repos with `--all-neeto-repos`
-neetob make_repos_uptodate --all-neeto-repos
+# Update all neeto repos by passing the value `all` to`--repos` option
+neetob make_repos_uptodate --repos "all"
+
 ```
 
 Executing the above mentioned command will check and clone all the missing neeto repos in the current working directory and will update all of them to the latest version. After the execution of command the directories will look something like this:
@@ -473,11 +418,3 @@ neetob local ls --dir public --apps "neeto-*-web"
 # List files in a nested directory
 neetob local ls --dir app/controllers --apps "neeto-*-web"
 ```
-
-## Testing
-
-For testing `github` commands use - [neeto-dummy](https://github.com/bigbinary/neeto-dummy) repo.
-
-For testing `heroku` commands use - [neeto-dummy](https://dashboard.heroku.com/apps/neeto-dummy) app.
-
-**Note:** Contact your respective Team Lead if you don't have access.

data/docs/development.md

@@ -0,0 +1,53 @@
+### Installing neetob for development
+
+Clone the repository onto your system using the following command:
+
+```sh
+git clone https://github.com/bigbinary/neetob.git
+```
+
+Navigate to the root of the application directory.
+
+```sh
+cd neetob
+```
+
+To check and use the latest changes in the local repository install `neetob` like so:
+
+```sh
+bin/setup
+```
+
+We can use, check or debug the `neetob` locally by directly invoking the `neetob` class like so:
+
+```sh
+ruby exe/neeetob
+```
+
+### Conventional commit messages
+
+In `neetob` we are using the Google's [release please](https://github.com/googleapis/release-please) Github action to auto update the version and release the latest gem.
+
+In order to make this action work we have to use the [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
+
+The Conventional commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history.
+
+Generally, we use three types of suffix in the commit messages that are as follows:
+
+1. `fix:` for the commit that fixes a bug in the codebase. This updates the third digit in the version. For example, `0.1.0` version will be updated to `0.1.1`.
+
+2. `feat:` for the commit that introduces a new feature to the codebase. This updates the second digit in the version. For example, `0.1.0` version will be updated to `0.2.0`.
+
+3. `BREAKING CHANGE:` for the commit that introduces a breaking API change. This updates the first digit in the version. For example, `0.1.0` version will be updated to `1.0.0`.
+
+For more details please refer [official docs](https://www.conventionalcommits.org/en/v1.0.0/) from Conventional commits.
+
+In `neetob` we use "squash and merge" option while merging the PR. So we have to update the commit message while squash and merge so that Github action can track that merge commit.
+
+For example:
+
+![Commit message update](../images/commit-message-update.png)
+
+### Gem release
+
+When a commit is added to the `main` branch [release](.github/workflows/release.yml) Github action checks that commit for the [conventional commit message](#conventional-commit-messages). If a proper suffix like `fix:`, `feat:`, etc is used in that commit message then the Github action will create a new PR with the updated version and changelog. The version and changelog for the `neetob` gem are updated automatically by the Github action using the commit message. When we merge this newly created PR by the Github action into the main branch, an updated Gem is released to the [rubygems](https://rubygems.org).

data/docs/testing.md

@@ -0,0 +1,7 @@
+# Testing instructions
+
+For testing `github` commands use - [neeto-dummy](https://github.com/bigbinary/neeto-dummy) repo.
+
+For testing `heroku` commands use - [neeto-dummy](https://dashboard.heroku.com/apps/neeto-dummy) app.
+
+**Note:** Contact your respective Team Lead if you don't have access.

data/lib/neetob/cli/fetchorupdate_repos/execute.rb

@@ -6,46 +6,46 @@ module Neetob
   class CLI
     module FetchorupdateRepos
       class Execute < Base
-        attr_accessor :sandbox, :apps
+        attr_accessor :sandbox, :repos
 
-        def initialize(sandbox = false, apps = ["*"])
+        def initialize(sandbox = false, repos = ["*"])
           super()
           @sandbox = sandbox
-          @apps = apps
+          @repos = repos
         end
 
         def run
-          neeto_apps = find_all_matching_apps_or_repos(apps, :github, sandbox)
-          neeto_apps.each do |app|
-            app_name = app.split("/").last
-            ui.info("\nWorking on #{app_name}\n")
-            if directory_exists(app_name)
-              checkout_to_main_and_fetch_commits(app_name)
+          neeto_repos = find_all_matching_apps_or_repos(repos, :github, sandbox)
+          neeto_repos.each do |repo|
+            repo_name = repo.split("/").last
+            ui.info("\nWorking on #{repo_name}\n")
+            if directory_exists(repo_name)
+              checkout_to_main_and_fetch_commits(repo_name)
             else
-              clone_repo(app_name)
+              clone_repo(repo_name)
             end
           end
         end
 
-        def directory_exists(app_name)
-          File.directory?(app_name)
+        def directory_exists(repo_name)
+          File.directory?(repo_name)
         end
 
-        def checkout_to_main_and_fetch_commits(app_name)
-          %x[ cd #{app_name} && git checkout main && git pull origin main ]
+        def checkout_to_main_and_fetch_commits(repo_name)
+          %x[ cd #{repo_name} && git checkout main && git pull origin main ]
           if $?.success?
-            puts "------Successfully pulled main branch of #{app_name}------"
+            puts "------Successfully pulled main branch of #{repo_name}------"
           else
-            puts "------Unable to pull the main branch of #{app_name} due to conflicts------"
+            puts "------Unable to pull the main branch of #{repo_name} due to conflicts------"
           end
         end
 
-        def clone_repo(app_name)
-          `git clone git@github.com:bigbinary/#{app_name}.git`
+        def clone_repo(repo_name)
+          `git clone git@github.com:bigbinary/#{repo_name}.git`
           if $?.success?
-            puts "------Done cloning #{app_name}------"
+            puts "------Done cloning #{repo_name}------"
           else
-            puts "------Failed cloning #{app_name}------"
+            puts "------Failed cloning #{repo_name}------"
           end
         end
       end

data/lib/neetob/cli.rb

@@ -37,8 +37,10 @@ module Neetob
     subcommand "code", Code::Commands
 
     desc "make_repos_uptodate", "Uptodate all neeto repos"
+    option :repos, type: :array, aliases: "-r", default: ["*"],
+      desc: "Github repo names. Can be matched using the '*' wildcard. Example: \"neeto*\" \"neeto-cal-web\", also providing \"all\" as value matches all neeto repos. Note: The default value is \"*\", hence all neeto repos would be affected."
     def make_repos_uptodate
-      FetchorupdateRepos::Execute.new(options[:sandbox]).run
+      FetchorupdateRepos::Execute.new(options[:sandbox], options[:repos]).run
     end
   end
 end

data/lib/neetob/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neetob
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Udai Gupta
@@ -106,6 +106,8 @@ files:
 - data/config-vars-list.json
 - data/config-vars-upsert.json
 - data/github-labels.json
+- docs/development.md
+- docs/testing.md
 - exe/neetob
 - images/commit-message-update.png
 - install.sh