alihan/github-contribution-graph-action
1
0
Fork 0
mirror of https://github.com/bcanseco/github-contribution-graph-action.git synced 2025-10-09 13:41:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): reorganize environment variables

Browse Source
This commit is contained in:
Borja Canseco
2020-06-03 23:43:24 -05:00
parent 2fb495ce7b
commit c8d2974b6d
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -107,10 +107,10 @@ Keep reading for more cool stuff like:
| `GIT_COMMIT_MESSAGE` | The message to use for commits made by this GitHub Action. | `chore(actions): empty commit for contribution graph` | |
| `ORIGIN_TIMESTAMP` | The unix timestamp to start commits on. If you set `MAX_DAYS` greater than 1, commits will be made on days prior to this time. | The current timestamp | |
| `MAX_DAYS` | The maximum integer number of days to commit on. If you want to backfill a year of commits, set this to `365`. | `1` | |
| `INCLUDE_WEEKDAYS` | A boolean indicating whether or not to make commits on weekdays. | `true` | |
| `INCLUDE_WEEKENDS` | A boolean indicating whether or not to make commits on weekends. | `true` | |
| `MIN_COMMITS_PER_DAY` | The minimum integer number of commits to make per day (inclusive). Used by a pseudo-RNG. | `1` | |
| `MAX_COMMITS_PER_DAY` | The maximum integer number of commits to make per day (inclusive). Used by a pseudo-RNG. | `1` | |
| `INCLUDE_WEEKDAYS` | A boolean indicating whether or not to make commits on weekdays. | `true` | |
| `INCLUDE_WEEKENDS` | A boolean indicating whether or not to make commits on weekends. | `true` | |
| `FORCE_PUSH` | A boolean indicating whether or not to force push. **WARNING:** Setting this to `true` will clear out your repo on each run! | `false` | |
### Advanced environment variables 🧙‍♂️

4
src/index.js
View File

@@ -18,10 +18,10 @@ const {
ORIGIN_TIMESTAMP = getUnixTime(new Date()),
MAX_DAYS = 1,
INCLUDE_WEEKDAYS = true,
INCLUDE_WEEKENDS = true,
MIN_COMMITS_PER_DAY = 1,
MAX_COMMITS_PER_DAY = 1,
INCLUDE_WEEKDAYS = true,
INCLUDE_WEEKENDS = true,
FORCE_PUSH = false,
} = process.env;