Skip to content

Commit

Permalink
docs(readme): last but not least add EMPTY_COMMIT_MSG to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tuunit committed Mar 28, 2024
1 parent 7b4c4be commit bb18e13
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,15 @@ You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/

Use the following `input params` to customize it for your use case:-

| Input Param | Default Value | Description |
| -------------- | ----------------------------------------------------- | --------------------------------------------------------- |
| `GH_USERNAME` | Your GitHub username | Username for which to generate the activity overview |
| `COMMIT_NAME` | github-actions[bot] | Name of the committer |
| `COMMIT_EMAIL` | 41898282+github-actions[bot]@users.noreply.github.com | Email of the committer |
| `COMMIT_MSG` | :zap: Update README with the recent activity | Commit message used while committing to the repo |
| `MAX_LINES` | 5 | The maximum number of lines populated in your readme file |
| `TARGET_FILE` | README.md | The file to insert recent activity into |
| Input Param | Default Value | Description |
| ------------------ | ------------------------------------------------------------------------ | --------------------------------------------------------- |
| `GH_USERNAME` | Your GitHub username | Username for which to generate the activity overview |
| `COMMIT_NAME` | github-actions[bot] | Name of the committer |
| `COMMIT_EMAIL` | 41898282+github-actions[bot]@users.noreply.github.com | Email of the committer |
| `COMMIT_MSG` | :zap: Update README with the recent activity | Commit message used while committing to the repo |
| `EMPTY_COMMIT_MSG` | :memo: empty commit to keep workflow active after 60 days of no activity | Commit message used when there are no updates |
| `MAX_LINES` | 5 | The maximum number of lines populated in your readme file |
| `TARGET_FILE` | README.md | The file to insert recent activity into |

```yml
name: Update README
Expand Down

0 comments on commit bb18e13

Please sign in to comment.