Skip to content

Commit 9559606

Browse files
Change README to reflect that env var overrides git, not just a fallback (#128)
1 parent 2b3207c commit 9559606

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ commitInfo(folder)
3737

3838
Notes:
3939

40-
- Code assumes there is `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B`, see [src/git-api.js](src/git-api.js). Note: there is fallback to environment variables.
40+
- Code assumes there is `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B`, see [src/git-api.js](src/git-api.js). Note: this can be overrided by environment variables.
4141
- Resolves with [Bluebird](https://github.com/petkaantonov/bluebird) promise.
4242
- Only uses Git commands, see [src/git-api.js](src/git-api.js)
4343
- If a command fails, returns `null` for each property
4444
- If you need to debug, run with `DEBUG=commit-info` environment variable.
4545

46-
## Fallback environment variables
46+
## Override with environment variables
4747

48-
If getting the commit information using `git` fails for some reason, you can provide the commit information by setting the environment variables. This module will look at the following environment variables as a fallback
48+
If getting the commit information using `git` fails for some reason, or you want to override them, you can provide the commit information by setting the environment variables. This module will look at the following environment variables as a fallback
4949

5050
```
5151
branch: COMMIT_INFO_BRANCH

0 commit comments

Comments
 (0)