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

fix: normalize template file loadup

Browse Source
This commit is contained in:
Simone Corsi
2022-05-11 10:00:38 +02:00
parent ec10b79a91
commit 445f562fb5
3 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -8,7 +8,6 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
<!-- toc --> <!-- toc -->
- [Table of Contents](#table-of-contents)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Configuration](#configuration) - [Configuration](#configuration)
@@ -21,32 +20,34 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
### Requirements ### Requirements
- An empty repository - An empty repository
- A personal github api key - A personal github api key
### Configuration ### Configuration
The service can be configured setting the appropriate environment variables or writing an `.env` file. The service can be configured setting the appropriate environment variables or writing an `.env` file.
| Variable | Description | Default | | Variable | Description | Default |
| -------------- | ------------------------------------------- | -------------------------------- | | ----------------- | -------------------------------------------------------------------- | -------------------------------- |
| `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` | | `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` |
| `github-token` | Action Token | `${{ secrets.GITHUB_TOKEN }}` | | `github-token` | Action Token | `${{ secrets.GITHUB_TOKEN }}` |
| `github-name` | Name used for the commit, default to action | Github Action | | `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 | | `github-email` | email used for commit, default to action | actions@users.noreply.github.com |
| `template-path` | Custom output template file ([EJS](https://ejs.co/) template engine) | [TEMPLATE.ejs](./TEMPLATE.ejs) |
| `output-filename` | Output filename | `README.md` |
#### `api-token` #### `api-token`
The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits. The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits.
You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add
## Example workflow ## Example workflow
```yml ```yml
name: Update awesome list name: Update awesome list
on: on:
workflow_dispatch: workflow_dispatch:
schedule: schedule:
- cron: '0 0 * * *' - cron: '0 0 * * *'
@@ -63,5 +64,4 @@ jobs:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
github-email: ${{ secrets.USER_EMAIL }} github-email: ${{ secrets.USER_EMAIL }}
github-name: ${{ github.repository_owner }} github-name: ${{ github.repository_owner }}
``` ```

3
src/template.ts → TEMPLATE.ejs
View File

@@ -1,4 +1,4 @@
export default `# <%= username %> Awesome List [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) # <%= username %> Awesome List [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
> :star: generated with [simonecorsi/mawesome](https://github.com/simonecorsi/mawesome) > :star: generated with [simonecorsi/mawesome](https://github.com/simonecorsi/mawesome)
@@ -11,4 +11,3 @@ export default `# <%= username %> Awesome List [![Awesome](https://cdn.rawgit.co
<% } %> <% } %>
<% } %> <% } %>
`;

9
src/index.ts
View File

@@ -1,5 +1,6 @@
import path from 'path';
import * as core from '@actions/core'; import * as core from '@actions/core';
import { readdir, readFile } from 'fs/promises'; import { readFile } from 'fs/promises';
import ghStarFetch from 'gh-star-fetch'; import ghStarFetch from 'gh-star-fetch';
import { import {
@@ -9,11 +10,13 @@ import {
pushNewFiles, pushNewFiles,
MARKDOWN_FILENAME, MARKDOWN_FILENAME,
} from './helpers'; } from './helpers';
import MD_TEMPLATE from './template';
export async function main() { export async function main() {
// set default template // set default template
let template = MD_TEMPLATE; let template = await readFile(
path.resolve(__dirname, './TEMPLATE.md'),
'utf8'
);
// get template if found in the repo // get template if found in the repo
const customTemplatePath = core.getInput('template-path'); const customTemplatePath = core.getInput('template-path');