outreach_gem 1.0.62 → 1.0.64

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b2db4ddc7c1e2a1bf76bbc52eafd4a507af30f9bb5758c64809033dbaa6f3ec
-  data.tar.gz: 657130bb74db470e8211b74a7c80d661a2bf2056a2adf658a21a0db6a0e80279
+  metadata.gz: 583dff6caf5e5700c26a3766da985bd101e81dfe13ebae98bf93924a91d37d9a
+  data.tar.gz: a447fcad60f655a2a10ea121edad7c6b9082f85a0a55e19e1a0a8d11a7455907
 SHA512:
-  metadata.gz: '0931e9151072b9e1d05156a914225e644dc1f9d2f5d738ad61a007caccecb3ddb520a2b346b827a770b3be7de7aabd5e019b8e6bfe0b3ffbd31a11e5447879ce'
-  data.tar.gz: 54744a18ef6b061c0cfb29e285727e4e82269fdc14d916d09f95364ad358d2606124b976fee940a7582a150b826c8805922fc6633842e8c80901c42cf2288bc5
+  metadata.gz: a4a529882416d94d0bd19ce7e219d2a633109ca9572967c594d4d0dd33ffa3f7fac5a104c74c0758dfc241a61853861ba5b41313342710c275cfc69f7c7a1a7b
+  data.tar.gz: 9a956842d3b53f63689e8c1aad159b766071124e2f36edac565a9645116c68199c2ef00cf7c7626963ca33f53d014777f13e4f8449142e705f121c758122656e

data/lib/release/release-ruby.rb

@@ -30,46 +30,68 @@ class Release
         }
     end
 
+    # Remove the word -SNAPSHOT from a string
+    # @param version [String] remove the word SNAPSHOT from the version string
+    # @return [String] String without the word -SNAPSHOT
     def self.removeSnapshot(version)
         return version.sub('-SNAPSHOT', '')
     end
 
+    # Get the maven version of a project, must have maven 3.x or higher installed
+    # @param projectLocation [String] Change directories to the projectLocation location
+    # @param newVersion [String] Change the maven project version to the newVersion
     def self.mavenVersion(projectLocation, newVersion)
         Dir.chdir(projectLocation){
             `mvn versions:set -DnewVersion=#{newVersion} -DgenerateBackupPoms=false`
         }
     end
 
+    # Perform a merge operation between two branches
+    # @param projectLocation [String] Change directories to the projectLocation location
+    # @param branch [String] The branch you would like to merge into your project
     def self.gitMerge(projectLocation, branch)
         Dir.chdir(projectLocation) {
             `git merge #{branch}`
         }
     end
 
+    # Perform a checkout operation on a repository
+    # @param projectLocation [String] Change directories to the projectLocation location
+    # @param branch [String] The branch you would like to checkout
     def self.gitCheckout(projectLocation, branch)
         Dir.chdir(projectLocation) {
             `git checkout #{branch}`
         }
     end
 
+    # Perform a add . operation on a repository
+    # @param projectLocation [String] Change directories to the projectLocation location
     def self.gitAddAll(projectLocation)
         Dir.chdir(projectLocation) {
             `git add .`
         }
     end
 
+    # Perform a commit operation on a repository
+    # @param projectLocation [String] Change directories to the projectLocation location
+    # @param commitMessage [String] The message to add to the Git commit
     def self.gitCommit(projectLocation, commitMessage)
         Dir.chdir(projectLocation) {
             `git commit -m "#{commitMessage}"`
         }
     end
 
+    # Perform a push operation on a repository
+    # @param projectLocation [String] Change directories to the projectLocation location
     def self.gitPush(projectLocation)
         Dir.chdir(projectLocation) {
             `git push origin`
         }
     end
 
+    # Perform a tag operation on a repository
+    # @param projectLocation [String] Change directories to the projectLocation location
+    # @param tagName [String] The name of the tag to apply
     def self.gitTag(projectLocation, tagName)
         Dir.chdir(projectLocation) {
             `git tag #{tagName}`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outreach_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.62
+  version: 1.0.64
 platform: ruby
 authors:
 - Patrique Legault