gha_config 0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9d19ff5b1e9e5061ace6d37d397e5e7404525d6ce101b74cb9532db251d30b4
+  data.tar.gz: '09ec807d50a2b8c55e50ddc0691a577458a0a62967d540f67402e0c38b39a87a'
+SHA512:
+  metadata.gz: d7973193d71d199bf15c9a858e7ab307fe6e6f58d606acdeb26127906f7f1125cf102236f9b62ecfcdb38fbc25548cfce640e33edd6318d1048235de1b9019f3
+  data.tar.gz: cfc3111a028a9bb696b51030aa66b9ccc62146153d312b31bc98f19114b3a18a8e432ad2f68347f09f6a433019aeab613b9bd06d66f8385dd91fca9e12bfb77f

data/README.md

@@ -0,0 +1,131 @@
+# gha_config
+
+This gem will process a templated file and output a GitHub Action workflow file specific to Flipp workflows. The idea is that you can maintain a small, lean config file without a lot of repetition and copy/pasting, and process it to export a "real" workflow file for GitHub to use.
+
+## 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.
+
+Install using `gem install gha_config`.
+
+## Usage
+
+Create a file called `.github/workflow-src/CI.yml` in the base directory of your app. You can think of this file as a regular GitHub Action workflow file, except for two differences:
+
+1. Certain "global / always needed" steps and settings do not need to be added, as they will be auto-added after processing.
+2. The file supports special *template* keys which can be replaced later on.
+
+Run the command with `gha_config` - it will output the file into `.github/workflows/CI.yml`.
+
+### Template keys
+
+Template keys are very similar to [YAML anchors](http://blogs.perl.org/users/tinita/2019/05/reusing-data-with-yaml-anchors-aliases-and-merge-keys.html). Unfortunately GitHub does not support anchors, and in addition anchors have a weakness in that you cannot use them to extend arrays/lists.
+
+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:
+
+```yaml
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+    - develop
+
+defaults_:
+  _container_:
+    image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster-node
+    credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GHCR_TOKEN }}
+  _cache_:
+    - name: Bundle cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        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()
+  _setup_:
+    - _cache_
+    - name: Bundle install
+      run: bundle install --jobs=4
+
+jobs:
+  build:
+    container: _container_
+    steps:
+      - _setup_
+      - _teardown_
+```
+
+The output of this file will look like this:
+```yaml
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+    - develop
+
+env:
+  HOME: /home/circleci
+  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+  AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
+  AWS_REGION: ${{ secrets.AWS_REGION }}
+  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+  DEPLOYMENT_TYPE: ${{ secrets.DEPLOYMENT_TYPE }}
+  ECR_REPOSITORY: ${{ secrets.ECR_REPOSITORY }}
+  ECS_CLUSTER_PROD: ${{ secrets.ECS_CLUSTER_PROD }}
+  ECS_CLUSTER_STG: ${{ secrets.ECS_CLUSTER_STG }}
+  ECS_SERVICE_PROD: ${{ secrets.ECS_SERVICE_PROD }}
+  ECS_SERVICE_STG: ${{ secrets.ECS_SERVICE_STG }}
+  SERVICE_NAME: ${{ secrets.SERVICE_NAME }}
+  SERVICE_PROFILE: ${{ secrets.SERVICE_PROFILE }}
+  SERVICE_TOKEN: ${{ secrets.SERVICE_TOKEN }}
+  WISHABI_ENVIRONMENT: ${{ secrets.WISHABI_ENVIRONMENT }}
+
+jobs:
+
+  build:
+    runs-on: [ubuntu, runner-fleet]
+    container:
+      image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster-node
+      credentials:
+        username: "${{ github.repository_owner }}"
+        password: "${{ secrets.GHCR_TOKEN }}"
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Bundle cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: rails-${{ hashFiles('Gemfile.lock') }}
+        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()
+```
+
+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.
+
+You can add this gem to your app Gemfile and re-run it whenever your "source workflow" changes.
+
+## Contributing
+
+Pull requests are welcome!

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: gha_config
+version: !ruby/object:Gem::Version
+  version: '0.10'
+platform: ruby
+authors:
+- Daniel Orner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description. Optional.
+email:
+- daniel.orner@flipp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.21
+signing_key:
+specification_version: 4
+summary: Process GitHub Action workflow files
+test_files: []