Skip to content
file-text

GitHub Action

create-json

v1.2.3 Latest version

create-json

file-text

create-json

Create an JSON file from secret or a string of a json

Installation

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

 
              
- name: create-json

              
  uses: jsdaniell/create-json@v1.2.3
Learn more about this action in jsdaniell/create-json

Choose a version

Create a .json file dynamically on your workflow

Example of the output on the .json file created:

{
    "name":"jsdaniell",
    "password":"mypass"
}

How to use

You can define a json structure on the secrets of your repository:

{
    "name":"jsdaniell",
    "password":"mypass"
}

MY_JSON (Secrets variables can be configured on repository settings > Secrets)

and use in this way:

    - name: create-json
      id: create-json
      uses: jsdaniell/create-json@v1.2.3
      with:
        name: "credentials.json"
        json: ${{ secrets.MY_JSON }}

Or just declare a string of a json on the property json like:

    - name: create-json
      id: create-json
      uses: jsdaniell/create-json@v1.2.3
      with:
        name: "new-json-file.json"
        json: '{"name":"jsdaniell", "password":"mypass"}'

The json have to be inside a string.

You also can save the json on a subdirectory using the property dir:

    - name: create-json
      id: create-json
      uses: jsdaniell/create-json@v1.2.3
      with:
        name: "credentials.json"
        json: ${{ secrets.CREDENTIALS_JSON }}
        dir: 'src/'

Remember that when you create a .json file, the file was not commited, you have to commit the file if you will use the HEAD branch with the file to push the repository to other service, like deploy to heroku or other platforms.

If you want to create more than one json files, you have to specify different IDs for the action like:

    - name: create-json
      id: create-json-1 # First ID
      uses: jsdaniell/create-json@v1.2.3
      with:
        name: "credentials.json"
        json: ${{ secrets.CREDENTIALS_JSON }}
        dir: 'src/'
    - name: create-json
      id: create-json-2  # Second ID
      uses: jsdaniell/create-json@v1.2.3
      with:
        name: "other.json"
        json: '{"name":"jsdaniell", "password":"mypass"}'
        dir: 'src/'

Real Example (Creating and Using on Other Steps)

name: Heroku CI - CD

on:
  push:
    branches: [ master ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: actions/setup-go@v1
        with:
          go-version: '1.14.6'
      - run: cd src && go mod vendor
      - name: create-json
        id: create-json
        uses: jsdaniell/create-json@v1.2.3
        with:
          name: "devdatatools-firebase-adminsdk.json"
          json: ${{ secrets.CREDENTIALS_JSON }}
          dir: "src/"
      - run: git config --global user.email "jose.daniell@outlook.com" && git config --global user.name "jsdaniell" && git add . && git add --force src/devdatatools-firebase-adminsdk.json && git status && git commit -a -m "Deploy Heroku Commit with the Credentials JSON created!"
      - uses: akhileshns/heroku-deploy@v3.4.6
        with:
          heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
          heroku_app_name: "dev-data-tools-api-golang"
          heroku_email: "jose.daniell@outlook.com"
          appdir: "src"

After commit and use with Heroku the file is deleted after the workflow and the JSON is not showed on the log, perfect for public repositories.

Contribute

You can submit an issue or PR anytime for the improvement this action!

Version v1.2.3 (Node 20)