actions/mawesome
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: updates readme

Browse Source
This commit is contained in:
GitHub Actions
2022-05-11 16:20:39 +02:00
parent 7841262e74
commit 90a2e06350
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -12,6 +12,7 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
- [Requirements](#requirements)
- [Configuration](#configuration)
- [`api-token`](#api-token)
- [`template-path`](#template-path)
- [Example workflow](#example-workflow)
<!-- tocstop -->
@@ -27,14 +28,14 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
The service can be configured setting the appropriate environment variables or writing an `.env` file.
| Variable | Description | Default |
| ----------------- | -------------------------------------------------------------------- | -------------------------------- |
| `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` |
| `github-token` | Action Token | `${{ secrets.GITHUB_TOKEN }}` |
| `github-name` | Name used for the commit, default to action | Github Action |
| `github-email` | email used for commit, default to action | actions@users.noreply.github.com |
| `template-path` | Custom template path relative to your project directory (uses: [EJS](https://ejs.co/) template engine) | [TEMPLATE.ejs](./TEMPLATE.ejs) |
| `output-filename` | Output filename | `README.md` |
| Variable | Description | Default |
| ----------------- | -------------------------------------------------------- | -------------------------------- |
| `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` |
| `github-token` | This is the default github token used to commit and push | `${{ secrets.GITHUB_TOKEN }}` |
| `github-name` | Name used for the commit | Github Action |
| `github-email` | email used for commit | actions@users.noreply.github.com |
| `template-path` | Custom `README.md` template, [read more](#template-path) |
| `output-filename` | Output filename | `README.md` |
#### `api-token`
@@ -42,6 +43,12 @@ The Personal API Access Token is mandatory to fetch stars from the API without i
You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add
#### `template-path`
If you don't like the output (default example [here](./TEMPLATE.ejs) ), you can provide your custom template that will be rendered using [EJS](https://ejs.co/) template engine.
Path provided is relative to your current repository directory, if file is not found it will default.
## Example workflow
```yml