yaml-env-action - A custom action for setting GitHub Workflow environment variables with YAML configuration files.
Introduction
yaml-env-action is a custom JavaScript action that allows for the setting of GitHub Workflow environment variables with YAML configuration files. The action can take multiple YAML files input that override eachother, allowing for multi-environment configuration.
Features
- Set GitHub Workflow environment variables using a list of YAML configuration files.
- Pass multiple files to get environment overrides.
- Complex YAML structures are supported.
Usage
With configuration file in the root directory of your project
# env.yaml
name: Example Config
webserver:
url: www.example.com
And the following added to your GitHub Workflow
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env1.yaml # Pass a space-separated list of configuration files. Rightmost files take precedence.
Access the newly exported environment variable in the following steps of your GitHub Workflow.
...
steps:
- uses: actions/checkout@v2
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env1.yaml # Pass a space-separated list of configuration files. Rightmost files take precedence.
- run: echo "${{ env.WEBSERVER_URL }}"
...
Another Example
A simple example...
With the following YAML configuration file.
projectId: xxx
tfBucket: xxx
deployBucket: xxx
dnsName: xxx
Using the yaml-env-action allows you to reference the configured values as environment variables.
on:
push:
branches:
- main
jobs:
infrastructure:
name: "Infrastructure"
runs-on: ubuntu-latest
steps:
- name: Install Terraform
run: |
curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
sudo apt-get update
sudo apt-get install terraform -y
- name: Checkout
uses: actions/checkout@v2
# Use the yaml-env-action action.
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env.yaml # Pass a space-separated list of configuration files. Rightmost files take precedence.
- name: Set up Cloud SDK
uses: google-github-actions/setup-gcloud@master
with:
project_id: ${{ env.PROJECT_ID }}
service_account_key: ${{ secrets.BUILD_KEY_PROD }}
export_default_credentials: true
- name: Terraform Init
working-directory: ./infrastructure
run: terraform init -backend-config="bucket=${{ env.TF_BUCKET }}"
- name: Terraform Apply
working-directory: ./infrastructure
run: |
terraform apply -auto-approve -no-color -var "project_id=${{ env.PROJECT_ID }}" -var "dns_name=${{ env.DNS_NAME }}" \
-var "deploy_bucket=${{ env.DEPLOY_BUCKET }}"
outputs:
deploy_bucket: ${{ env.DEPLOY_BUCKET }}
deploy:
name: "Deploy"
runs-on: ubuntu-latest
needs:
- infrastructure
steps:
- name: Checkout
uses: actions/checkout@v2
# Use the yaml-env-action action.
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env.yaml
- name: Build website
run: |
yarn
yarn build
- name: Set up Cloud SDK
uses: google-github-actions/setup-gcloud@master
with:
project_id: ${{ env.PROJECT_ID }}
service_account_key: ${{ secrets.BUILD_KEY_PROD }}
export_default_credentials: true
- name: Deploy to bucket
run: |
gsutil rsync -r build/ gs://${{ needs.infrastructure.outputs.deploy_bucket }}
Environment Variable Names
Environment variables will be available in their flattened, capital-case form. For example, a YAML file like the following:
app:
projectId: project-34n28c
name: my-app
dns: my-app.com
database:
hostname: localhost
The following environment variables will be exported:
APP_PROJECT_IDAPP_NAMEAPP_DNSAPP_DATABASE_HOSTNAME
Multiple Files
Multiple files can be passed to the files parameter of the action. This allows for various interesting use cases.
Note that the rightmost files override values in the leftmost files if their keys intersect.
...
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env1.yaml env2.yaml # Pass a space-separated list of configuration files. Rightmost files take precedence.
...
Simple Composition
Multiple files can be passed to the files parameter to allow for multiple composed environment files to be available to the workflow.
...
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env1.yaml env2.yaml # Pass a space-separated list of configuration files. Rightmost files take precedence.
...
Environment Overrides
Multiple files can be passed in a way that takes advantage of the rightmost-precedence to supply a set of base values and overriding environment values.
Given the following two configuration files.
# env.base.yaml
name: application
terraform:
bucket: f46cc6e2-86e3-428d-b266-612d7913ef2d
# env.dev.yaml
webService:
dns: my-d.webservice.com
apiService:
dns: api-d.webservice.com
name: application-dev
Both can be refered to in the action.
...
- name: Load environment from YAML
uses: doughepi/yaml-env-action
with:
files: env.base.yaml env.dev.yaml
...
You end up with the following environment variables.
NAME=application-devTERRAFORM_BUCKET=f46cc6e2-86e3-428d-b266-612d7913ef2dWEB_SERVICE_DNS=my-d.webservice.comAPI_SERVICE_DNS=my-d.apiservice.com
Contributing
All contributions are welcome. Create an issue for questions, bugs, and features. Feel free to submit pull requests, as well. The overall development process is detailed below.
Development Process
Create a development branch to make your changes within.
Get the node_modules/
npm install
On your branch, you can make changes and push. The test.yml GitHub Workflow on this repository will kick off on each push, running simple unit and integration tests. Take a look at test.yml for more info on how this works. Feel free to add additional integration tests to verify your changes result in correct operation of the yaml-env-action.
You can also run the unit tests locally.
npm test
Before you create a pull request, you'll need to make sure the dist/ folder is fully up to date with your changes.
npm run prepare
Releases will be handled by @doughepi using tags and releases on the main branch.
—
yaml-env-action is MIT licensed code. Designed & built in Minneapolis, MN. Used at General Mills.
105 Jan 2, 2023
33 Dec 25, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
4 Aug 28, 2022
7 Dec 26, 2022
62 Dec 14, 2022
10 Aug 10, 2022
102 Sep 23, 2022
9 Dec 28, 2022
15 Dec 30, 2022
7 Sep 15, 2022
62 Jan 3, 2023
5 Dec 28, 2022
4 Nov 30, 2022
20 Jun 14, 2022
9 Dec 30, 2022
2 Jun 21, 2022