gha_config 0.17 → 0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d6f4522cd5ee962dab579769563ebe5eb98e41f7183876f8886bc3053a2f9a'
-  data.tar.gz: e2dbb45afde2fa01072ca64069a51444107173ee3b4bef3c32e5d1ede11e746c
+  metadata.gz: fab829ad50d5bd6bc14923bed4ff281f84c6e5d97be1259a6245495877fb1be5
+  data.tar.gz: 23755419b447948a847f540319c8e8d0fb7c32b2c0467e8e567f054168e64456
 SHA512:
-  metadata.gz: ca61e7d7ac283a1dfd92ba763460f9ca996076d8f4c6811a38da694b7616242cba4d00930fa9b0415b5f1b2b09184b7a1538ecbbd87763024fdaacfc73cca137
-  data.tar.gz: fdcb23e50ef4d9906f75490d2306061671317c37d7e92b6e75e6d1d53f6fbc3d63e24a6f9067fe74d195c3205af0249f23421f83fc6f3ef4075166b19d0d7370
+  metadata.gz: c9c58c07938cfe3a465fba48eb274fb4938eaaeb9d5c89f7b96d2e0df02b7b7ebccb5554764a43c84f77833e3e63e41598d22112dbc655a21397527582cdce5d
+  data.tar.gz: 34ae3c384b458fef9756b04c703fa635ca3d6017fece60ac48105734fa3f4c2aa8a96cecdbc87288feef67f08d7d0a2a0411767f0a72d675620bad7d1744c5bd

data/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.21] - 2021-08-20
+- Added ARTIFACTORY env variables by default for Scala builds.
+
+## [0.20] - 2021-08-09
+- Added `_variables_` for substitution.
+
+## [0.19] - 2021-08-06
+- Add `_options_` for submodules and SSH.
+
 ## [0.17] - 2021-08-04
 - Adds submodules to checkout action
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gha_config (0.15)
+    gha_config (0.20)
 
 GEM
   remote: https://flipplib.jfrog.io/flipplib/api/gems/flipp-gems/

data/README.md

@@ -131,16 +131,44 @@ Templates get expanded into their contents whenever they are used. Templates can
 
 If you're using Ruby, you can add this gem to your app Gemfile. Otherwise, you can install it locally. Either way, you can re-run it whenever your "source workflow" changes.
 
-### Notes on checkout Step
-A checkout step is added to every job in the workflow. This looks like below
+### Variables
+
+You can define simple variables in a separate section. These variables will be replaced with their values when they appear anywhere in the input workflow file surrounded by *double underscores*. For example:
+
+```yaml
+_variables_:
+  PROD_BRANCH: master
+  STAGING_BRANCH: develop
+
+on:
+  push:
+    - __PROD_BRANCH__
+    - __STAGING_BRANCH__
 ```
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.FLIPPCIRCLECIPULLER_REPO_TOKEN || github.token }}
-          submodules: recursive
+
+will output:
+
+```yaml
+on:
+  push:
+    - master
+    - develop
 ```
-The submodules are fetched ONLY by adding the `FLIPPCIRCLECIPULLER_REPO_TOKEN` in github repo secrets.
+
+### Special options
+
+In addition to `_defaults_`, there are other options that will affect how the output of certain steps is emitted. These options are parsed from the `_options_` key:
+
+```yaml
+_options_:
+  use_submodules: true
+  enable_ssh: true
+```
+
+* `use_submodules`: If this is set it will check out code recursively with submodules. This requires two things:
+    * A secret called `FLIPPCIRCLECIPULLER_REPO_TOKEN` - Eng Cap will need to add this
+    * Your repo needs to have a Git version > 2.18
+* `enable_ssh`: If set to true, the Flipp global action will have SSH enabled on failures. This should generally only be set to true while debugging things.
 
 ## Contributing
 

data/lib/gha_config/config.rb

@@ -3,11 +3,15 @@ module GhaConfig
     attr_accessor :defaults
     attr_accessor :env
     attr_accessor :parsed_config
+    attr_accessor :options
+    attr_accessor :variables
 
     def initialize
       @env = {}
       @defaults = []
       @parsed_config = {}
+      @options = {}
+      @variables = {}
     end
   end
 end

data/lib/gha_config/parser.rb

@@ -6,6 +6,8 @@ module GhaConfig
       hash = YAML.safe_load(input)
       config = GhaConfig::Config.new
       config.defaults = hash.delete('_defaults_') || {}
+      config.options = hash.delete('_options_') || {}
+      config.variables = hash.delete('_variables_') || {}
       config.env = hash.delete('env') || {}
 
       hash['jobs'] = replace_defaults(config, hash['jobs'])

data/lib/gha_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GhaConfig
-  VERSION = '0.17'
+  VERSION = '0.21'
 end

data/lib/gha_config/writer.rb

@@ -26,8 +26,12 @@ module GhaConfig
                 'SERVICE_NAME'          => '${{ secrets.SERVICE_NAME }}',
                 'SERVICE_PROFILE'       => '${{ secrets.SERVICE_PROFILE }}',
                 'SERVICE_TOKEN'         => '${{ secrets.SERVICE_TOKEN }}',
-                'WISHABI_ENVIRONMENT'   => '${{ secrets.WISHABI_ENVIRONMENT }}'
-              })
+                'WISHABI_ENVIRONMENT'   => '${{ secrets.WISHABI_ENVIRONMENT }}',
+                'ARTIFACTORY_HOST'      => '${{ secrets.ARTIFACTORY_HOST }}',
+                'ARTIFACTORY_PASSWORD'  => '${{ secrets.ARTIFACTORY_PASSWORD }}',
+                'ARTIFACTORY_REALM'     => '${{ secrets.ARTIFACTORY_REALM }}',
+                'ARTIFACTORY_USER'      => '${{ secrets.ARTIFACTORY_USER }}'
+      })
 
       output_hash['jobs'] = {}
       config.parsed_config['jobs'].each do |name, job|
@@ -35,30 +39,38 @@ module GhaConfig
           'runs-on' => '[ubuntu, runner-fleet]'
         }
         job['runs-on'] = '[ubuntu, runner-fleet]'
-        job['steps'].unshift({
-                                'name' => 'Flipp global',
-                                'uses' => 'wishabi/github-actions@v0.4',
-                                'env' => {
-                                  'SLACK_BOT_TOKEN' => "${{ secrets.SLACK_BOT_TOKEN }}"
-                                },
-                                'timeout-minutes' => 10,
-                                'with' => {
-                                  'slack_channel' => '${{env.SLACK_CHANNEL }}',
-                                  'job_status' => '${{ job.status }}'
-                                }})
-        job['steps'].unshift({
-                               'name' => 'Checkout code',
-                               'uses' => 'actions/checkout@v2',
-                               'with' => {
-                                 'token' => "${{ secrets.FLIPPCIRCLECIPULLER_REPO_TOKEN || github.token }}",
-                                 'submodules' => 'recursive'
-                                }})
+        flipp_global = {
+          'name' => 'Flipp global',
+          'uses' => 'wishabi/github-actions@v0.4',
+          'env' => {
+            'SLACK_BOT_TOKEN' => "${{ secrets.SLACK_BOT_TOKEN }}"
+          },
+          'timeout-minutes' => 10,
+          'with' => {
+            'slack_channel' => '${{env.SLACK_CHANNEL }}',
+            'job_status' => '${{ job.status }}'
+          }}
+        if config.options['enable_ssh']
+          flipp_global['with']['enable_ssh'] = true
+        end
+        job['steps'].unshift(flipp_global)
+        checkout = {
+          'name' => 'Checkout code',
+          'uses' => 'actions/checkout@v2'
+        }
+        if config.options['use_submodules']
+          checkout['with'] = {
+            'token' => "${{ secrets.FLIPPCIRCLECIPULLER_REPO_TOKEN }}",
+            'submodules' => 'recursive'
+          }
+        end
+        job['steps'].unshift(checkout)
         job['needs'] = "[#{job['needs'].join(', ')}]" if job['needs'].is_a?(Array)
         new_job.merge!(job)
         output_hash['jobs'][name] = new_job
       end
       output = output_hash.to_yaml
-      output = cleanup(output)
+      output = cleanup(output, config)
       header = <<-OUT
 ######## GENERATED FROM ./github/workflow-src/CI.yml
 ######## USING gha_config https://github.com/wishabi/gha-config
@@ -69,7 +81,7 @@ module GhaConfig
       File.write(output_file, output)
     end
 
-    def self.cleanup(out)
+    def self.cleanup(out, config)
       out = out.sub("---\n", '')
       out = out.gsub(/'on'/, 'on') # replace 'on' with on
       out = out.gsub(/: ''/, ':') # replace : '' with :
@@ -77,6 +89,10 @@ module GhaConfig
       out = out.gsub(/"\[/, '[')
       out = out.gsub(/\]"/, ']') # change "[...]" to [...]
 
+      config.variables.each do |name, val|
+        out = out.gsub("__#{name}__", val)
+      end
+
       first, last = out.split("\njobs:")
       first = first.gsub(/"/, '') # remove quotes from env block
       last = last.gsub(/\n  (\S)/) { "\n\n  #{$1}" } # add empty line before job keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gha_config
 version: !ruby/object:Gem::Version
-  version: '0.17'
+  version: '0.21'
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop