Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamsauravsharma/create-dotenv
Create dotenv file for GitHub actions
https://github.com/iamsauravsharma/create-dotenv
dotenv env environment-variables github-actions hacktoberfest
Last synced: 27 days ago
JSON representation
Create dotenv file for GitHub actions
- Host: GitHub
- URL: https://github.com/iamsauravsharma/create-dotenv
- Owner: iamsauravsharma
- License: mit
- Created: 2021-04-25T06:22:46.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-09T03:40:14.000Z (about 1 year ago)
- Last Synced: 2024-04-24T15:13:40.094Z (8 months ago)
- Topics: dotenv, env, environment-variables, github-actions, hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 376 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create dotenv action
This action creates dotenv file
## Inputs
### `input-prefix`
The prefix for environmental variable which should be stored in dot env file. Default is empty string i.e `''` which will store all environmental variable as it is without modification expects environment variable which starts with prefix `GITHUB_` or `RUNNER_`. If you needs to also add `GITHUB_` or `RUNNER_` environment variable create another steps which has prefix set to `GITHUB_` or `RUNNER_`
### `file-path`
Location of dot env file. Default is `'.env'`
### `output-prefix`
The prefix which should be added to .env file. Default is `''` which adds environment variable as it is after removing input-prefix from it
## Example usage
```yaml
name: Create env file
on: [push]
env: # env available for all jobs all steps
PRODUCTION: true
ENV_KEY_PROJECT_NAME: dot-env
jobs:
create-env-file:
name: Create env file
runs-on: ubuntu-latest
env: # env available for all steps of jobs
ENV_KEY_DEBUG: true
ENV_KEY_USERNAME: root
steps:
- uses: actions/checkout@v4
- uses: iamsauravsharma/[email protected]
with:
input-prefix: 'ENV_KEY_' # Optional (default: '')
file-path: 'tests/development.env' # Optional (default : '.env')
output-prefix: 'OUTPUT_' # Optional (default: '')
env: # env available for only this steps
IS_SERVER: true
ENV_KEY_USERNAME: admin
ENV_KEY_API_KEY: USER_API_KEY
ENV_KEY_SECRET_KEY: secret123
ENV_KEY_MULTILINE: |
multi line value
is here
```
will create a development.env file in tests/ directory which would contain
```bash
OUTPUT_PROJECT_NAME=dot-env
OUTPUT_USERNAME=admin
OUTPUT_DEBUG=true
OUTPUT_API_KEY=USER_API_KEY
OUTPUT_SECRET_KEY=secret123
OUTPUT_MULTILINE="multi line value
is here"
```
### Important Notes
When using multi-line values (like ENV_KEY_MULTILINE in the example), the action will automatically wrap the value in quotes and retain the line breaks. This makes it compatible with the .env format. Single-line values are added directly without quotes.