gha_config 0.19 → 0.23.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16a002da5b1417fffef6cf22c9ec166e258c4000377072a952fa8998f9c33146
-  data.tar.gz: f822acdf86ae16bc7b94275777ce0f693a154b8d417d16845e3ac993889b49e7
+  metadata.gz: 5a40dd08d619080435933f18a3af9755deb248e9e5b61154363c6c0025d34825
+  data.tar.gz: 92b641b92ef4a8df9abf3f02b516bba5f7e0e5faeb3513076774fbe1b52fb043
 SHA512:
-  metadata.gz: 730cf61647df7abffa62cf6ed4fc35bff2bee33dd0365e5e8a13b0c42f49f7cbf7286ac93d0d5bf859026d8bdd0fe1a617cb90dd8eab2a2d0c44f0684664b433
-  data.tar.gz: b73d3b11704a7ed1dddffeaffa8a2219fbb3486fc3df996386008d9deaf3ea0f081b1e2317c5d776ec3f661fda3566bb3db3a30fce05d44faf256aea30508af3
+  metadata.gz: 13ca7b74a37c167c2d43eec550d10c46e9bc24d996a24cfbdc65bc959a6d237e1c112609a007d5bf5205bbc5a9d8d33bf2161a9bae5f3f08192534c359a84d81
+  data.tar.gz: 388225ab6e85ab7e7c038c8ac0a06179eb0a0bab757e525a0c3367cdcd568ad1466f44e836fa753dc768f064a4a7b177f238873e890e3e18d44132c09f4731ea

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.22] - 2021-11-16
+- Fixed so root-level `env` are not overridden by defaults.
+
+## [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.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gha_config (0.15)
+    gha_config (0.22)
 
 GEM
   remote: https://flipplib.jfrog.io/flipplib/api/gems/flipp-gems/
@@ -35,4 +35,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.2.21
+   2.2.26

data/README.md

@@ -131,6 +131,30 @@ 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:

data/lib/gha_config/config.rb

@@ -4,12 +4,14 @@ module GhaConfig
     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

@@ -7,6 +7,7 @@ module GhaConfig
       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.19'
+  VERSION = '0.23.beta1'
 end

data/lib/gha_config/writer.rb

@@ -10,7 +10,7 @@ module GhaConfig
       default_env =  {
         'SLACK_CHANNEL' => ''
       }
-      output_hash['env'] = default_env.merge(config.env).
+      output_hash['env'] = default_env.
         merge({
                 'HOME'                  => '/home/circleci',
                 'AWS_ACCESS_KEY_ID'     => '${{ secrets.AWS_ACCESS_KEY_ID }}',
@@ -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 }}'
+      }).merge(config.env)
 
       output_hash['jobs'] = {}
       config.parsed_config['jobs'].each do |name, job|
@@ -50,23 +54,25 @@ module GhaConfig
           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'
+        unless job['steps'].any? { |s| s['uses'] == 'actions/checkout@v2'}
+          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)
         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
@@ -77,7 +83,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 :
@@ -85,6 +91,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.19'
+  version: 0.23.beta1
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -61,9 +61,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.21
 signing_key: