intello-shipit-cli 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5126aa0637e578a48a5397bfaefe6132aa072d5ddced245a64d0276a55b91758
-  data.tar.gz: 788290efb0c5542976c01a84e832c9594f1cd6dbc4e9d55dbd1a29813a704a3f
+  metadata.gz: e8357db54113d84cd737edb6bf57228fa235df527fba88af7de8eecaa4d0f5d4
+  data.tar.gz: 3716cc73141f21833285e40a3b1b3f28199de3eae8d0133008e5b36e35015d92
 SHA512:
-  metadata.gz: a5d61e0f9290bb580de0d11486ea57e70f16c6f5374208da5053ac6226bf8be7d9e306c6f2182a00f1700c59aff8654b62723517caac4ffd32bbdbfddacc49da
-  data.tar.gz: 4a3209be7a52944d9c8cca5ba834f02f538930cc5c5096115ff9b030feedff48be40a133f28ea5c043060b5312ba3fc50e2b49b08fb13f7634815fce46a90045
+  metadata.gz: 63e909865718db3d151bfdaed972b7f127cd9d905ee42f5a6584849d4d5b706156ba98c795a12acfff063b4375e0762b6c2bd66de31e1e4d9a0564d095f7f8e5
+  data.tar.gz: 27dee93a4f8a9a667eda387f8946509708738f63c7e1cd1c29d4e48bef437a28117829d893c63c6e6a8925289deeaa3e8686df5e15266814a3b24041c768a752

data/Changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+NOTE: the project follows [Semantic Versioning](http://semver.org/).
+
+## Firmware
+
+### v1.1.0 - February 7th, 2022
+
+- [enhancement] #5 - Run shipit from a Docker environement for nonLinux environement
+- [task] #1 - Support gitlab.com new Draft status
+
+### v1.0.0 - November 25th, 2021
+
+- Inivial version
+

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright Intello Technologies Inc, 2016-2019.
+Copyright Intello Technologies Inc, 2016-2020.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -12,29 +12,64 @@ Designed to simplify collaboration with Git and Gitlab, its main purpose is to k
 
 ## Requirements
 
-- Ruby 2.5+
+- Git
 - A `gitlab` personal access token (`https://{{ YOUR_GITLAB_HOST  }}/profile/personal_access_tokens`)
 - Issues must have a label and a milestone
 
 `intello-shipit-cli` works as well on gitlab.com as on a privately hosted instance of Gitlab
 
+### Linux / macOS
+
+- Ruby 2.5+
+
+### Windows
+
+- Docker
+
+A .shipit.yml file must exist in `C:\Users\[my_user]\.shipit.yml` or to a path specified by `-c [path_to_file]`
+SSH keys should be present in `C:\Users\[my_user]\.ssh`
+
+Here is an example of the format of the file :
+
+```yaml
+---
+endpoint:            endpoint
+private_token:       private_token
+```
+
+As an example, the [endpoint for gitlab.com](https://docs.gitlab.com/ee/api/#current-status) is `https://gitlab.intello.com/api/v4`.
+
 ## Install/Update
 
+### Linux / macOS
+
 ```bash
 gem install intello-shipit-cli
 ```
 
 > NOTE: If you use a ruby manager, the gem has to be installed each time you want to use it in a new ruby context.
 
-### PROTIP
+#### PROTIP
 
 If you use rbenv as your ruby manager, and want to easily install/update `intello-shipit-cli` across all your rubies:
 
 1. Install [rbenv-each](https://github.com/rbenv/rbenv-each)
 1. Run `rbenv each gem install intello-shipit-cli`
 
+### Windows
+
+Move `shipit-windows.bat` to a folder present in your environment %PATH%.
+shipit-windows.bat needs to be run from a gitlab project.
+
+#### Known issues
+
+- Virtualization may not be enabled on certain AMD processors.
+- From our experience, You may need to update to Windows build 2004 and re-install Docker or Docker Desktop to fix the above mentionned issue.
+
 ## Setup
 
+### Linux
+
 You must first setup `intello-shipit-cli` by running:
 
 ```bash
@@ -48,6 +83,12 @@ This will interactivly ask you for:
 
 The setup will create a file in your user root folder called `.shipit.yml` with this information.
 
+### Windows
+
+You must manually set up your `.shipit.yml` file in your home directory : `C:\Users\[your_user]\.shipit.yml`
+Setup will be performed when you first run `shipit-windows.bat`.
+First time use may take a few minutes to configure its Docker environment.
+
 ### PROTIP
 
 If you have multiple Gitlab servers or account you can manually create configuration YAML files and use the `-c` option of `intello-shipit-cli` to select the proper configuration.
@@ -138,7 +179,7 @@ You can write tests using `rspec v3+` syntax in the `spec` folder. To run the te
 
 ## License
 
-Copyright Intello Technologies Inc, 2016-2019. Licensed under the [MIT license](/LICENSE?raw=true).
+Copyright Intello Technologies Inc, 2016-2020. Licensed under the [MIT license](/LICENSE?raw=true).
 
 ## About Intello Technologies Inc.
 

data/lib/shipit/cli/version.rb

@@ -1,5 +1,5 @@
 module Shipit
   module Cli
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/shipit/cli/work.rb

@@ -63,7 +63,10 @@ module Shipit
       end
 
       def create_merge_request(issue)
-        return if dry_run?
+        if dry_run?
+          puts "    - Merge request name: #{issue["merge_request_title"]}"
+          return
+        end
         opts = issue.slice("source_branch", "target_branch", "assignee_id", "labels", "milestone_id", "remove_source_branch")
         client.create_merge_request(project_path,
                                     issue["merge_request_title"],
@@ -92,7 +95,7 @@ module Shipit
         assignee_id = assignee["id"]
         issue_title = sane_title.parameterize[0..20]
         first_commit_message = "[#{labels}] Fixes ##{issue_id} - #{sane_title}"
-        mr_title = "[WIP] [#{labels}] ##{issue_id} - #{sane_title}"
+        mr_title = "Draft: [#{labels}] ##{issue_id} - #{sane_title}"
 
         # 2. Add to issue properties
         issue["source_branch"] = [issue["labels"].first.gsub(/\s+/, ""), assignee_initials, issue_id, issue_title].compact.join("-")

data/shipit-cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "gli", "~> 2.13"
   spec.add_dependency "gitlab", "~> 4.3.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0.1"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-ctags-bundler"
   spec.add_development_dependency "guard-rspec"

data/shipit-windows.bat

@@ -0,0 +1,60 @@
+@echo off
+
+docker info > NUL 2>&1
+
+REM Checks if docker is running or not
+if errorlevel 1 (
+    echo Please install or start Docker
+    exit /b 1
+)
+
+REM If a -c flag is passed as the first argument
+IF [%1] == [-c] (
+    
+    REM If the file doesn't exist, stop here
+    IF [%2] NEQ [] (
+        IF NOT EXIST "%2" (
+            echo %2 - File does not exist
+            exit /b 1
+        )
+    )
+
+    REM Otherwise copy the config file to WORKDIR of container
+    xcopy /y %2 . > NUL 2>&1
+)
+
+REM Create temp dockerfile
+(
+    echo FROM ruby:2.5
+    echo RUN gem install intello-shipit-cli
+    echo WORKDIR /usr/src/project
+) > %TEMP%\Dockerfile
+
+REM Check if Ruby container already is installed locally
+docker inspect --type=image ruby:2.5 > NUL 2>&1
+
+IF errorlevel 1 (
+    ECHO Please wait while we perform a first-time setup for shipit on your Windows environment. This can take several minutes.
+)
+
+REM Build Container
+docker build -t "shipit-docker" -f %TEMP%\Dockerfile . > NUL 2>&1
+
+REM Depending on is -c was passed, use the right arg number to run container
+IF [%1] == [-c] (
+    docker run -v %CD%:/usr/src/project ^
+    -v %HOMEDRIVE%%HOMEPATH%"\authorized_keys":/root/.ssh/authorized_keys ^
+    -v %HOMEDRIVE%%HOMEPATH%"\.gitconfig":/root/.gitconfig ^
+    -v %HOMEDRIVE%%HOMEPATH%"\.ssh":/root/ssh_temp/ ^
+    --rm shipit-docker:latest /bin/bash -c "cp -f /root/ssh_temp/* /root/.ssh/ ; chmod 0600 /root/.ssh/* ; shipit -c .shipit.yml %3 %4"
+    del .shipit.yml
+) else (
+    docker run -v %CD%:/usr/src/project ^
+    -v %HOMEDRIVE%%HOMEPATH%"\authorized_keys":/root/.ssh/authorized_keys ^
+    -v %HOMEDRIVE%%HOMEPATH%"\.gitconfig":/root/.gitconfig ^
+    -v %HOMEDRIVE%%HOMEPATH%"\.ssh":/root/ssh_temp/ ^
+    -v %HOMEDRIVE%%HOMEPATH%"\.shipit.yml":/root/.shipit.yml ^
+    --rm shipit-docker:latest /bin/bash -c "cp -f /root/ssh_temp/* /root/.ssh/ ; chmod 0600 /root/.ssh/* ; shipit -c /root/.shipit.yml %1 %2"
+)
+
+del %TEMP%\Dockerfile

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intello-shipit-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Thouret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-style.yml"
 - ".ruby-version"
+- Changelog.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -215,6 +216,7 @@ files:
 - script/release
 - script/test
 - shipit-cli.gemspec
+- shipit-windows.bat
 homepage: https://gitlab.com/intello/shipit-cli
 licenses:
 - MIT
@@ -234,8 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Designed to simplify working with Gitlab, its main purpose is to kickstart