gha_config 0.16 → 0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 276069863b70861f12f3d76fc4054920f9a90859b0e48c58f198f87a1156bcbc
-  data.tar.gz: 18281dc811434e385db5f95109da89051ec7cca89d1d1eb56a584c01289528ea
+  metadata.gz: f38b004057c7f52c5d24ccd7d75d65e323dbc64f57256f472b32e7b5d03a63cf
+  data.tar.gz: c0405f8dcc6adb2457267eaccc6fee2e30d2247f0d4dc0db744f5d82903017ee
 SHA512:
-  metadata.gz: 324bfce26f456d6a5b506339b3ad021dc6ca59aa2a47fbceef054479853a7e955aff8981406ff59df6f9fb6cfa68f3f9befbb0c84c400f56afecbbd36b2eeca1
-  data.tar.gz: 1e91fce0673ef84daac35503ff658ef558a26bc9b36b8ea0915e528a483f6a232174c92c7a5de670beb60de38b833364a3edb5dfc3e2c3b02db7f45a9a6e95d5
+  metadata.gz: 37a0c649ee04795bc424852b31fef982eac4cadb765e6e87857f3ab546d9a58e746653f068a8211f16345f823f756fb13b05c4c0e5a273207fc4b9ed594d31f9
+  data.tar.gz: 01c6da0bcee2d280badb5deca83cbb51b18f9c402064c3b58ddc0feadce438bf53eed6c2663dc202531e14a61d1be2fa76936e899022cbacc6cd13249873a0eb

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,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.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
+
 ## [0.16] - 2021-07-27
 - Remove dependency on activesupport and byebug
 - Auto-create directory if it doesn't exist

data/README.md

@@ -131,6 +131,45 @@ 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.
 
+### 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__
+```
+
+will output:
+
+```yaml
+on:
+  push:
+    - master
+    - develop
+```
+
+### 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/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.16'
+  VERSION = '0.20'
 end

data/lib/gha_config/writer.rb

@@ -35,27 +35,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'
-                             })
+        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
@@ -66,7 +77,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 :
@@ -74,6 +85,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.16'
+  version: '0.20'
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-08-09 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
-