Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spicypizza/create-envfile
Github Action to create a .env file with Github Secrets
https://github.com/spicypizza/create-envfile
actions continuous-integration environment-variables github-actions
Last synced: 2 days ago
JSON representation
Github Action to create a .env file with Github Secrets
- Host: GitHub
- URL: https://github.com/spicypizza/create-envfile
- Owner: SpicyPizza
- License: mit
- Created: 2019-08-20T23:16:32.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T13:14:33.000Z (11 months ago)
- Last Synced: 2025-01-13T02:05:34.557Z (9 days ago)
- Topics: actions, continuous-integration, environment-variables, github-actions
- Language: TypeScript
- Homepage:
- Size: 1.19 MB
- Stars: 430
- Watchers: 4
- Forks: 73
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Create .Env File GitHub Action
[](https://github.com/SpicyPizza/create-envfile/releases/latest)
[](https://github.com/marketplace/actions/create-env-file)
[](https://github.com/SpicyPizza/create-envfile/blob/main/LICENSE)
## About
A GitHub Action to create an '.env' file with GitHub Secrets. This is useful
when you are creating artifacts that contain values stored in GitHub Secrets.
This creates a file with variables that are defined in the Action config.
## Usage
The Action looks for environment variables that start with `envkey_` and creates
an '.env' file with them. These are defined in the `with` section of the Action
config. Here is an example of it in use:
```yml
name: Create envfile
on: [ push ]
jobs:
create-envfile:
runs-on: ubuntu-latest
steps:
- name: Make envfile
uses: SpicyPizza/[email protected]
with:
envkey_DEBUG: false
envkey_SOME_API_KEY: "123456abcdef"
envkey_SECRET_KEY: ${{ secrets.SECRET_KEY }}
envkey_VARIABLE: ${{ vars.SOME_ACTION_VARIABLE }}
some_other_variable: foobar
directory:
file_name: .env
fail_on_empty: false
sort_keys: false
```
## Inputs
In the example above, there are several key/value pairs that will be added to
the '.env' file:
| Name | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `envkey_DEBUG`, `envkey_SOME_API_KEY` | These values can be whatever, and they will be added to the '.env' file as `DEBUG` and `SOME_API_KEY` . |
| `envkey_SECRET_KEY` | This one will use a secret stored in the repository's GitHub Secrets, and add it to the file as `SECRET_KEY` |
| `directory` (**Optional**) | This key will set the directory in which you want to create `env` file. **Important: cannot start with `/`. Action will fail if the specified directory doesn't exist.** |
| `file_name` (**Optional**) | Set the name of the output '.env' file. Defaults to `.env` |
| `fail_on_empty` (**Optional**) | If set to true, the Action will fail if any env key is empty. Default to `false`. |
| `sort_keys` (**Optional**) | If set to true, the Action will sort the keys in the output '.env' file. Default to `false`. |
Assuming that the GitHub Secret that was used is `password123`, the '.env' file
that is created from the config above would contain:
```text
DEBUG=false
SOME_API_KEY="123456abcdef"
SECRET_KEY=password123
```
### Multiline Secrets
This Action supports multiline secrets, as described in [the nodejs dotenv
readme](https://github.com/motdotla/dotenv#multiline-values).
You may have a secret that requres multiple lines, like a private key. You can
store this in a GitHub Secret, and use it as any other secret in this Action:
```sh
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...
Kh9NV...
...
-----END RSA PRIVATE KEY-----"
```
It will get stored as a single line in the '.env' file. This line will start and
end with a `"` character, and will contain `\n` characters to represent the
newlines:
```sh
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n"
```
## Potential Issues
### Warnings
When the Action runs, it will show `Warning: Unexpected input(s) ...`. This is
because GitHub is expecting all the potential input variables to be defined by
the Action's definition. You can read more about it in [this
issue](https://github.com/SpicyPizza/create-envfile/issues/10).
