Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
arrow-right

GitHub Action

variable-mapper

v0.1.0

variable-mapper

arrow-right

variable-mapper

Github Action for mapping variables by a specific key

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: variable-mapper

              
  uses: kanga333/variable-mapper@v0.1.0
Learn more about this action in kanga333/variable-mapper

Choose a version

Github Action for mapping variables by a specific key

build-test

Variable-Mapper action maps variables by regular expressions.

  • The map argument is a configuration in json format.
    • The top-level key in JSON is a regular expression condition. They are evaluated in order from the top.
    • The value is the key-value pair of variables to be exported.
  • The key argument is the key to match the map.

Sample Workflows

Export variables corresponding to regular expression-matched keys

on: [push]
name: Export variables corresponding to regular expression-matched keys
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: kanga333/variable-mapper@v1 
      with:
        key: ${{GITHUB_REF#refs/heads/}}
        map: |
          {
            "master": {
              "environment": "production",
              "AWS_ACCESS_KEY_ID": ${{ secrets.PROD_AWS_ACCESS_KEY_ID }},
              "AWS_SECRET_ACCESS_KEY": ${{ secrets.PROD_AWS_ACCESS_KEY_ID }}
            },
            "staging": {
              "environment": "staging",
              "AWS_ACCESS_KEY_ID": ${{ secrets.STG_AWS_ACCESS_KEY_ID }},
              "AWS_SECRET_ACCESS_KEY": ${{ secrets.STG_AWS_ACCESS_KEY_ID }}
            },
            ".*": {
              "environment": "development",
              "AWS_ACCESS_KEY_ID": ${{ secrets.DEV_AWS_ACCESS_KEY_ID }},
              "AWS_SECRET_ACCESS_KEY": ${{ secrets.DEV_AWS_ACCESS_KEY_ID }}
            }
          }
    - name: Echo environment
      run: echo ${{ env.environment }}

The key is evaluated from the top and exports the first matched variables.

Export variables to output and environment and log

on: [push]
name: Export variables to output and environment and log
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: kanga333/variable-mapper@v1 
      id: export
      with:
        key: ${{GITHUB_REF#refs/heads/}}
        map: |
          {
            "master": {
              "environment": "production"
            }
            ".*": {
              "environment": "development"
            }
          }
        export_to: env,log,output
    - name: Echo environment and output
      run: |
        echo ${{ env.environment }}
        echo ${{ steps.export.outputs.environment }}

The variables can be exported to log, env and output. (Default is log,env)