gha_config 0.17 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d6f4522cd5ee962dab579769563ebe5eb98e41f7183876f8886bc3053a2f9a'
-  data.tar.gz: e2dbb45afde2fa01072ca64069a51444107173ee3b4bef3c32e5d1ede11e746c
+  metadata.gz: 4dedc710facebd9c6ac3826132d29dabfa49304d6bb41ba6e143659611ea6f2f
+  data.tar.gz: eebaf08f4252ab8796b005732ed87745e9dea1978ad739fa8a25cd6417a40eed
 SHA512:
-  metadata.gz: ca61e7d7ac283a1dfd92ba763460f9ca996076d8f4c6811a38da694b7616242cba4d00930fa9b0415b5f1b2b09184b7a1538ecbbd87763024fdaacfc73cca137
-  data.tar.gz: fdcb23e50ef4d9906f75490d2306061671317c37d7e92b6e75e6d1d53f6fbc3d63e24a6f9067fe74d195c3205af0249f23421f83fc6f3ef4075166b19d0d7370
+  metadata.gz: 96212938458677189ca1576df3ec259e917e5b62455bb61c05e95c303588e9a78a69808dd3690fd564779032acf6a42586a4ed98d3adba2b3fed4efaa5aaf291
+  data.tar.gz: 156081246d3e7c70254f2ac1fea31006abe69ed0b2f9fea6ccf9ce3b127f2c5eac615f70c323c3401bed3e8942328915977fd24ca36ef8907446c284a1cc098c

data/CHANGELOG.md

@@ -5,6 +5,9 @@ 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.18] - 2021-08-06
+- Add `_options_` for submodules and SSH.
+
 ## [0.17] - 2021-08-04
 - Adds submodules to checkout action
 

data/README.md

@@ -131,16 +131,20 @@ 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
-```
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.FLIPPCIRCLECIPULLER_REPO_TOKEN || github.token }}
-          submodules: recursive
+### 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
 ```
-The submodules are fetched ONLY by adding the `FLIPPCIRCLECIPULLER_REPO_TOKEN` in github repo secrets.
+
+* `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,13 @@ module GhaConfig
     attr_accessor :defaults
     attr_accessor :env
     attr_accessor :parsed_config
+    attr_accessor :options
 
     def initialize
       @env = {}
       @defaults = []
       @parsed_config = {}
+      @options = {}
     end
   end
 end

data/lib/gha_config/parser.rb

@@ -6,6 +6,7 @@ module GhaConfig
       hash = YAML.safe_load(input)
       config = GhaConfig::Config.new
       config.defaults = hash.delete('_defaults_') || {}
+      config.options = hash.delete('_options_') || {}
       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.18'
 end

data/lib/gha_config/writer.rb

@@ -35,24 +35,32 @@ 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['env']['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 || github.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

metadata

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