gha_config 0.13 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b2cbe1be30f32bf1f88237e349b2a1e0ae2571df8e71c2d0a05c0a4c35e3d0
-  data.tar.gz: c3097850f7b446ba3e7060b190ca429877e6225b405b6f59cb7046743a915b76
+  metadata.gz: 4dedc710facebd9c6ac3826132d29dabfa49304d6bb41ba6e143659611ea6f2f
+  data.tar.gz: eebaf08f4252ab8796b005732ed87745e9dea1978ad739fa8a25cd6417a40eed
 SHA512:
-  metadata.gz: a3cb5333bfe9372ba143fc30bc39a20ff7baea723a0dfa2fcf869a2c9182c16deb3f26e3151dc99b53cdbbc8886e0ce1db40e91d53ed169d4a6c263a2821de49
-  data.tar.gz: c927252af563c8daf8abd1f656cf61e13adedaf80e1d1c94a17dbad47aa9b7ffb12313a51a36be433f09c74a28d8e78e42ebfa354ae852128da3f74a22902114
+  metadata.gz: 96212938458677189ca1576df3ec259e917e5b62455bb61c05e95c303588e9a78a69808dd3690fd564779032acf6a42586a4ed98d3adba2b3fed4efaa5aaf291
+  data.tar.gz: 156081246d3e7c70254f2ac1fea31006abe69ed0b2f9fea6ccf9ce3b127f2c5eac615f70c323c3401bed3e8942328915977fd24ca36ef8907446c284a1cc098c

data/.github/workflows/CI.yml

@@ -41,28 +41,3 @@ jobs:
       run: |
         sudo chmod 1777 -R /home/circleci/.bundle && bundle config path 'vendor/bundle' && bundle install --jobs=4
 
-  deploy-gem:
-    runs-on: [ubuntu, runner-fleet]
-    needs: [build]
-    container:
-      image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster
-      credentials:
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GHCR_TOKEN }}
-    if: github.ref == 'refs/heads/main'
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Bundle cache
-      uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: rails-{{ arch }}-{{ checksum "Gemfile.lock" }}
-        restore-keys: rails-{{ arch }}-
-    - name: Bundle install
-      run: |
-        sudo chmod 1777 -R /home/circleci/.bundle && bundle config path 'vendor/bundle' && bundle install --jobs=4
-    - name: Deploy to production
-      run: |
-        chmod +x ./deploy/artifactory.sh && ./deploy/artifactory.sh
-

data/CHANGELOG.md

@@ -5,6 +5,22 @@ 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
+
+## [0.16] - 2021-07-27
+- Remove dependency on activesupport and byebug
+- Auto-create directory if it doesn't exist
+
+## [0.15] - 2021-07-27
+- Fix bug where defaults are not given (uses [] instead of {})
+
+## [0.14] - 2021-07-22
+- Update global action to v0.4
+
 ## [0.13] - 2021-07-19
 - Fixes related to global action
 

data/Gemfile.lock

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

data/README.md

@@ -33,7 +33,7 @@ on:
     - master
     - develop
 
-defaults_:
+_defaults_:
   _container_:
     image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster-node
     credentials:
@@ -131,6 +131,21 @@ 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.
 
+### 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
 
 Pull requests are welcome!

data/bin/gha_config

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'active_support/all'
 require 'fileutils'
 
 require_relative '../lib/gha_config/parser'

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

@@ -1,5 +1,3 @@
-require 'byebug'
-
 module GhaConfig
   module Parser
     def self.parse(input_file)
@@ -7,7 +5,8 @@ module GhaConfig
       input.gsub!(/(^|\n)on:/, %(\n"on":))
       hash = YAML.safe_load(input)
       config = GhaConfig::Config.new
-      config.defaults = hash.delete('_defaults_') || []
+      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.13'
+  VERSION = '0.18'
 end

data/lib/gha_config/writer.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module GhaConfig
   module Writer
     def self.write(config, output_file)
@@ -33,21 +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.3',
-                                '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'
-                             })
+        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
@@ -60,6 +73,7 @@ module GhaConfig
 
       OUT
       output = header + output
+      FileUtils.mkdir_p(File.dirname(output_file))
       File.write(output_file, output)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gha_config
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '0.18'
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -32,7 +32,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflow-src"
 - ".github/workflows/CI.yml"
 - ".gitignore"
 - ".rubocop.yml"

data/.github/workflow-src

@@ -1,7 +0,0 @@
-prod_branch: main
-ci_image: ruby-2.6-stretch
-mysql: false
-kafka: false
-datadog: false
-redis: false
-