gha_config 0.11 → 0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 494d88f660f4f7b6aac5ab217afa7afb34e6c88c09ec357c811aca471ca19c8f
-  data.tar.gz: 1306d388bec13893965e811a8349a34e7b44b8fbc5be2bbe18a064d07a98931f
+  metadata.gz: 276069863b70861f12f3d76fc4054920f9a90859b0e48c58f198f87a1156bcbc
+  data.tar.gz: 18281dc811434e385db5f95109da89051ec7cca89d1d1eb56a584c01289528ea
 SHA512:
-  metadata.gz: 5b572dd14a4804d5ea444955d0b859acb920024d1341bee55d84b634a63d961c9199e31f10fc7416e05ee9c9381d88b77be073b3b6185c902e9038cbbc81da75
-  data.tar.gz: 7c1621af6526c97f81698d8499a9289e8353901ca52a49c071a8341eaa38a03bc8cea5880488694fab5f6b09cfe94570f8e51586e25f3624e233fb009dd608a8
+  metadata.gz: 324bfce26f456d6a5b506339b3ad021dc6ca59aa2a47fbceef054479853a7e955aff8981406ff59df6f9fb6cfa68f3f9befbb0c84c400f56afecbbd36b2eeca1
+  data.tar.gz: 1e91fce0673ef84daac35503ff658ef558a26bc9b36b8ea0915e528a483f6a232174c92c7a5de670beb60de38b833364a3edb5dfc3e2c3b02db7f45a9a6e95d5

data/CHANGELOG.md

@@ -5,5 +5,18 @@ 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.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
+
 ## [0.11] - 2021-07-15
 - First public version.

data/Gemfile.lock

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

data/README.md

@@ -4,7 +4,7 @@ This gem will process a templated file and output a GitHub Action workflow file
 
 ## Installation
 
-You will need Ruby 2.3 or greater to run this (most Macs have this preinstalled). Make sure you have the latest version of Rubygems as well.
+You will need Ruby 2.3 or greater to run this (you can install this via Homebrew if you don't have it). Make sure you have the latest version of Rubygems as well.
 
 Install using `gem install gha_config`.
 
@@ -23,7 +23,7 @@ Template keys are very similar to [YAML anchors](http://blogs.perl.org/users/tin
 
 Template keys all begin and end with underscores: `_`. You define template keys in a special `_defaults_` section in your config, and you can use them elsewhere.
 
-Here's an example of a templated GitHub Action workflow file:
+Here's an example of a templated GitHub Action workflow file.
 
 ```yaml
 on:
@@ -33,7 +33,7 @@ on:
     - master
     - develop
 
-defaults_:
+_defaults_:
   _container_:
     image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster-node
     credentials:
@@ -47,11 +47,8 @@ defaults_:
         key: rails-${{ hashFiles('Gemfile.lock') }}
         restore-keys: rails-
   _teardown_:
-    - name: Slack webhook
-      env:
-        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
-      uses: voxmedia/github-action-slack-notify-build@v2
-      if: failure()
+    - name: Cleanup
+    - run: docker cleanup
   _setup_:
     - _cache_
     - name: Bundle install
@@ -62,10 +59,13 @@ jobs:
     container: _container_
     steps:
       - _setup_
+      - name: Print build
+        run: ls dist/
       - _teardown_
 ```
 
-The output of this file will look like this:
+The output of this file will look like this (you can see that it auto-creates the checkout and "Flipp global" steps):
+
 ```yaml
 name: CI
 
@@ -105,6 +105,14 @@ jobs:
     steps:
     - name: Checkout code
       uses: actions/checkout@v2
+    - 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 }}"
     - name: Bundle cache
       uses: actions/cache@v2
       with:
@@ -113,18 +121,15 @@ jobs:
         restore-keys: rails-
     - name: Bundle install
       run: bundle install --jobs=4
-    - name: Slack webhook
-      env:
-        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
-      uses: voxmedia/github-action-slack-notify-build@v2
-      if: failure()
+    - name: Print build
+      run: ls dist/
+    - name: Cleanup
+      run: docker cleanup
 ```
 
-In the future, we will likely auto-add the Flipp "global action" to each job once it's created.
-
-Templates get expanded into their contents whenever they are used. Templates can also include templates (as you can see that the `setup` template includes the `cache` template). Finally, if a template is used inside a list of steps, the expansion will continue the list rather than nest it.
+Templates get expanded into their contents whenever they are used. Templates can also include templates (as you can see that the `_setup_` template includes the `_cache_` template). Finally, if a template is used inside a list of steps, the expansion will continue the list rather than nest it.
 
-You can add this gem to your app Gemfile and re-run it whenever your "source workflow" changes.
+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.
 
 ## Contributing
 

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/parser.rb

@@ -1,5 +1,3 @@
-require 'byebug'
-
 module GhaConfig
   module Parser
     def self.parse(input_file)
@@ -7,7 +5,7 @@ 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.env = hash.delete('env') || {}
 
       hash['jobs'] = replace_defaults(config, hash['jobs'])
@@ -17,13 +15,13 @@ module GhaConfig
 
     def self.replace_defaults(config, hash)
       if hash.is_a?(Array)
-        return hash.map { |v| self.replace_defaults(config, v)}.flatten
+        return hash.map { |v| self.replace_defaults(config, v)}.compact.flatten
       elsif hash.is_a?(Hash)
         return hash.map { |k, v| [k, self.replace_defaults(config, v)] }.to_h
       end
       return hash unless hash.is_a?(String) && hash =~ /_.*_/
+      return hash unless config.defaults.key?(hash)
       val = config.defaults[hash]
-      return hash if val.nil?
       if val.is_a?(Array)
         val.map { |v| self.replace_defaults(config, v) }.flatten
       else

data/lib/gha_config/version.rb

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

data/lib/gha_config/writer.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module GhaConfig
   module Writer
     def self.write(config, output_file)
@@ -5,7 +7,10 @@ module GhaConfig
       output_hash['name'] = 'CI'
       output_hash['on'] = config.parsed_config['on']
 
-      output_hash['env'] = config.env.
+      default_env =  {
+        'SLACK_CHANNEL' => ''
+      }
+      output_hash['env'] = default_env.merge(config.env).
         merge({
                 'HOME'                  => '/home/circleci',
                 'AWS_ACCESS_KEY_ID'     => '${{ secrets.AWS_ACCESS_KEY_ID }}',
@@ -30,6 +35,17 @@ 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'
@@ -40,6 +56,13 @@ module GhaConfig
       end
       output = output_hash.to_yaml
       output = cleanup(output)
+      header = <<-OUT
+######## GENERATED FROM ./github/workflow-src/CI.yml
+######## USING gha_config https://github.com/wishabi/gha-config
+
+      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.11'
+  version: '0.16'
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop