Skip to content

Commit e75c3da

Browse files
committed
consistency of .env file throughout documentation
1 parent 0fb358f commit e75c3da

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create Envfile Github Action
1+
# Create .Env file Github Action
22

33
[![GitHub
44
release](https://img.shields.io/github/release/SpicyPizza/create-envfile.svg?style=flat-square)](https://github.com/SpicyPizza/create-envfile/releases/latest)
@@ -10,15 +10,15 @@ marketplace](https://img.shields.io/badge/marketplace-create--env--file-blue?log
1010

1111
## About
1212

13-
A Github Action to create a .env file with Github Secrets. This is useful when
13+
A Github Action to create a '.env' file with Github Secrets. This is useful when
1414
you are creating artifacts that need to contain secrets stored in Github
1515
Secrets. This creates a file with variables that are defined in the Action
1616
config.
1717

1818
## Usage
1919

2020
The Action looks for environment variables that start with `envkey_` and creates
21-
an envfile with them. These are defined in the `with` section of the Action
21+
an '.env' file with them. These are defined in the `with` section of the Action
2222
config. Here is an example of it in use:
2323

2424
```yml
@@ -47,16 +47,16 @@ jobs:
4747
## Inputs
4848
4949
In the example above, there are several key/value pairs that will be added to
50-
the envfile:
50+
the '.env' file:
5151
5252
| Name | Description |
5353
|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
54-
| `envkey_DEBUG`, `envkey_SOME_API_KEY` | These values can be whatever, and they will be added to the envfile as `DEBUG` and `SOME_API_KEY` . |
54+
| `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` . |
5555
| `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` |
56-
| `directory` (**Optional**) | This key will set the directory in which you want to create `env` file. (Action will fail if the specified directory doesn't exist.) |
57-
| `file_name` (**Optional**) | Set the name of the output envfile. Defaults to `.env` |
56+
| `directory` (**Optional**) | This key will set the directory in which you want to create `.env` file. (Action will fail if the specified directory doesn't exist.) |
57+
| `file_name` (**Optional**) | Set the name of the output '.env'file. Defaults to `.env` |
5858

59-
Assuming that the Github Secret that was used is `password123`, the .env file
59+
Assuming that the Github Secret that was used is `password123`, the '.env' file
6060
that is created from the config above would contain:
6161

6262
```

0 commit comments

Comments
 (0)