https://github.com/vicradon/create-env-action

A github action that creates an .env file
https://github.com/vicradon/create-env-action

Last synced: 29 days ago
JSON representation

A github action that creates an .env file

• Host: GitHub
• URL: https://github.com/vicradon/create-env-action
• Owner: vicradon
• License: mit
• Created: 2024-08-09T16:31:48.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-11T12:43:59.000Z (5 months ago)
• Last Synced: 2024-08-11T18:40:55.357Z (5 months ago)
• Language: JavaScript
• Size: 1.63 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Create Env Action

This is a Github Action that creates an environment variable file (.env, app.env, etc) from values supplied. It's features include:

1. Creating a new environment file from supplied values

2. Updating an existing environment file with new values

## Usage

To use, reference the latest released tag in your workflow file and supply your desired env values in the with block. An example is shown below:

```yaml

name: Deploy to VM

on:

  push:

    branches: ["main"]

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Code

        uses: actions/checkout@v4

      - name: Create .env

        uses: vicradon/[email protected]

        with:

          action_input_file: .env.sample

          action_output_file: .env

          action_true_string_variables: |

            DB_PASSWORD

            APP_KEY

          DB_HOST: ${{ secrets.DB_HOST }}

          DB_USER: ${{ secrets.DB_USER }}

          DB_PASSWORD: ${{ secrets.DB_PASSWORD }}

          DB_NAME: ${{ secrets.DB_NAME }}

          DB_PORT: ${{ secrets.DB_PORT }}

          REDIS_HOST: ${{ secrets.REDIS_HOST }}

          REDIS_PORT: ${{ secrets.REDIS_PORT }}

          APP_NAME: ${{ secrets.APP_NAME }}

          APP_KEY: ${{ secrets.APP_KEY }}

      - name: Upload env file

        uses: appleboy/[email protected]

        with:

          host: ${{ secrets.HOST }}

          username: ${{ secrets.USERNAME }}

          password: ${{ secrets.PASSWORD }}

          source: .env

          target: /app/.env

      - name: Deploy app

        uses: appleboy/[email protected]

        with:

          host: ${{ secrets.HOST }}

          username: ${{ secrets.USERNAME }}

          password: ${{ secrets.PASSWORD }}

          script: |

            cd /app

            ./deploy.sh

```

## Inputs

There are three required inputs:

1. action_input_file - The path to the environment file you want to update

2. action_output_file - The path to the environment file you want to create or update

3. action_true_string_variables - A yaml, multi-line string that represents a list of variables that should be written with quotes

## Considerations

Github Actions will throw warnings for all the variables you set except the action_input_file and action_output_file. This is because we allow you to define any variable name you want and Github Actions does not know them.

## Contributing

Please feel free to raise issues or submit PRs.

## License

MIT