chore(release): v1.0.39

build(deps): bump path-parse from 1.0.6 to 1.0.7

.github/workflows/merge.yaml

@@ -0,0 +1,19 @@
+name: Test
+
+on: [pull_request]
+
+jobs:
+  version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: tests
+        run: npm cit

CHANGELOG.md

@@ -1,93 +1,35 @@
-## <small>1.0.28 (2021-01-16)</small>
+## <small>1.0.39 (2021-08-31)</small>
 
-* tests: added tests ([b8890fc](https://github.com/simonecorsi/mawesome/commit/b8890fc))
+* build(deps): bump path-parse from 1.0.6 to 1.0.7 ([ef137b5](https://github.com/simonecorsi/mawesome/commit/ef137b5))
 
 
 
-## <small>1.0.27 (2021-01-16)</small>
+## <small>1.0.38 (2021-06-23)</small>
 
-* chore(release): v1.0.27 ([bf07858](https://github.com/simonecorsi/mawesome/commit/bf07858))
+* chore(release): v1.0.38 ([3e66d85](https://github.com/simonecorsi/mawesome/commit/3e66d85))
-* docs: typo ([46172a5](https://github.com/simonecorsi/mawesome/commit/46172a5))
 
 
 
-## <small>1.0.26 (2021-01-16)</small>
+## <small>1.0.37 (2021-06-23)</small>
 
-* chore: added link to project ([0543c05](https://github.com/simonecorsi/mawesome/commit/0543c05))
+* chore(release): v1.0.37 ([1643092](https://github.com/simonecorsi/mawesome/commit/1643092))
-* chore(release): v1.0.26 ([8bc2714](https://github.com/simonecorsi/mawesome/commit/8bc2714))
+* build(deps): bump glob-parent from 5.1.1 to 5.1.2 ([e558e07](https://github.com/simonecorsi/mawesome/commit/e558e07))
+* build(deps): bump hosted-git-info from 2.8.8 to 2.8.9 ([110a667](https://github.com/simonecorsi/mawesome/commit/110a667))
+* build(deps): bump normalize-url from 4.5.0 to 4.5.1 ([202d6fe](https://github.com/simonecorsi/mawesome/commit/202d6fe))
 
 
 
-## <small>1.0.25 (2021-01-16)</small>
+## <small>1.0.36 (2021-06-23)</small>
 
-* chore: action name ([8f3ce98](https://github.com/simonecorsi/mawesome/commit/8f3ce98))
+* chore(release): v1.0.36 ([9c0b622](https://github.com/simonecorsi/mawesome/commit/9c0b622))
-* chore: moved helpers in own file ([29bcf41](https://github.com/simonecorsi/mawesome/commit/29bcf41))
+* feat: saving json data for future use ([7ceb9cb](https://github.com/simonecorsi/mawesome/commit/7ceb9cb))
-* chore: namings ([b16fdb0](https://github.com/simonecorsi/mawesome/commit/b16fdb0))
+
-* chore: post release script ([12dd0e4](https://github.com/simonecorsi/mawesome/commit/12dd0e4))
+
-* chore(action.yml): node downgrated to 12 ([f91b26b](https://github.com/simonecorsi/mawesome/commit/f91b26b))
+
-* chore(action.yml): updated ([7bdae48](https://github.com/simonecorsi/mawesome/commit/7bdae48))
+## <small>1.0.35 (2021-06-22)</small>
-* chore(release): 1.0.1 ([4193d0e](https://github.com/simonecorsi/mawesome/commit/4193d0e))
+
-* chore(release): 1.0.2 ([00b27bf](https://github.com/simonecorsi/mawesome/commit/00b27bf))
+* chore(release): v1.0.35 ([cee1906](https://github.com/simonecorsi/mawesome/commit/cee1906))
-* chore(release): 1.0.3 ([bb5dd1f](https://github.com/simonecorsi/mawesome/commit/bb5dd1f))
+* build(deps): bump set-getter from 0.1.0 to 0.1.1 ([970d603](https://github.com/simonecorsi/mawesome/commit/970d603))
-* chore(release): 1.0.4 ([be86777](https://github.com/simonecorsi/mawesome/commit/be86777))
-* chore(release): 1.0.5 ([a47a53f](https://github.com/simonecorsi/mawesome/commit/a47a53f))
-* chore(release): v1.0.1 ([e297342](https://github.com/simonecorsi/mawesome/commit/e297342))
-* chore(release): v1.0.10 ([c2a11da](https://github.com/simonecorsi/mawesome/commit/c2a11da))
-* chore(release): v1.0.11 ([ab4322e](https://github.com/simonecorsi/mawesome/commit/ab4322e))
-* chore(release): v1.0.12 ([0be94f1](https://github.com/simonecorsi/mawesome/commit/0be94f1))
-* chore(release): v1.0.13 ([ee21996](https://github.com/simonecorsi/mawesome/commit/ee21996))
-* chore(release): v1.0.14 ([91de25f](https://github.com/simonecorsi/mawesome/commit/91de25f))
-* chore(release): v1.0.15 ([03e1973](https://github.com/simonecorsi/mawesome/commit/03e1973))
-* chore(release): v1.0.16 ([f8cb892](https://github.com/simonecorsi/mawesome/commit/f8cb892))
-* chore(release): v1.0.17 ([380a0ec](https://github.com/simonecorsi/mawesome/commit/380a0ec))
-* chore(release): v1.0.18 ([d82b715](https://github.com/simonecorsi/mawesome/commit/d82b715))
-* chore(release): v1.0.19 ([7a46627](https://github.com/simonecorsi/mawesome/commit/7a46627))
-* chore(release): v1.0.2 ([3cba062](https://github.com/simonecorsi/mawesome/commit/3cba062))
-* chore(release): v1.0.20 ([738785e](https://github.com/simonecorsi/mawesome/commit/738785e))
-* chore(release): v1.0.21 ([3c3ab0a](https://github.com/simonecorsi/mawesome/commit/3c3ab0a))
-* chore(release): v1.0.22 ([3f66738](https://github.com/simonecorsi/mawesome/commit/3f66738))
-* chore(release): v1.0.23 ([f41befa](https://github.com/simonecorsi/mawesome/commit/f41befa))
-* chore(release): v1.0.24 ([9badeaf](https://github.com/simonecorsi/mawesome/commit/9badeaf))
-* chore(release): v1.0.25 ([14ccc97](https://github.com/simonecorsi/mawesome/commit/14ccc97))
-* chore(release): v1.0.3 ([71625bd](https://github.com/simonecorsi/mawesome/commit/71625bd))
-* chore(release): v1.0.4 ([46583c7](https://github.com/simonecorsi/mawesome/commit/46583c7))
-* chore(release): v1.0.5 ([ba24bdf](https://github.com/simonecorsi/mawesome/commit/ba24bdf))
-* chore(release): v1.0.6 ([6cb192b](https://github.com/simonecorsi/mawesome/commit/6cb192b))
-* chore(release): v1.0.7 ([410e2a7](https://github.com/simonecorsi/mawesome/commit/410e2a7))
-* chore(release): v1.0.8 ([324332b](https://github.com/simonecorsi/mawesome/commit/324332b))
-* chore(release): v1.0.9 ([7499f86](https://github.com/simonecorsi/mawesome/commit/7499f86))
-* fix: added latest tag at release ([6b8b525](https://github.com/simonecorsi/mawesome/commit/6b8b525))
-* fix: added missing info for action publishing ([3703b66](https://github.com/simonecorsi/mawesome/commit/3703b66))
-* fix: added required label ([173ce50](https://github.com/simonecorsi/mawesome/commit/173ce50))
-* fix: bad quotes in url ([76d0173](https://github.com/simonecorsi/mawesome/commit/76d0173))
-* fix: better errors ([f302126](https://github.com/simonecorsi/mawesome/commit/f302126))
-* fix: better template management ([9d06abc](https://github.com/simonecorsi/mawesome/commit/9d06abc))
-* fix: exit condition ([914a115](https://github.com/simonecorsi/mawesome/commit/914a115))
-* fix: git pull strategy ([edb4a38](https://github.com/simonecorsi/mawesome/commit/edb4a38))
-* fix: git push ([c8fb3f4](https://github.com/simonecorsi/mawesome/commit/c8fb3f4))
-* fix: if tempalte fail should exit(1) ([ee824d1](https://github.com/simonecorsi/mawesome/commit/ee824d1))
-* fix: imports ([2e421f0](https://github.com/simonecorsi/mawesome/commit/2e421f0))
-* fix: imports ([376451a](https://github.com/simonecorsi/mawesome/commit/376451a))
-* fix: should fix unshallow repo ([17c5d85](https://github.com/simonecorsi/mawesome/commit/17c5d85))
-* fix: somehow runner wont see template ([808c35c](https://github.com/simonecorsi/mawesome/commit/808c35c))
-* fix: splitting tokens ([bd47078](https://github.com/simonecorsi/mawesome/commit/bd47078))
-* fix: template cannot be loaded from ejs file ([78c0f37](https://github.com/simonecorsi/mawesome/commit/78c0f37))
-* fix: variable name ([13e1fd1](https://github.com/simonecorsi/mawesome/commit/13e1fd1))
-* fix(action.yml): output file now correct path ([98b17f8](https://github.com/simonecorsi/mawesome/commit/98b17f8))
-* fix(ci): bad syntax ([caaf6ab](https://github.com/simonecorsi/mawesome/commit/caaf6ab))
-* fix(index.ts): fs promise fixed path ([285e193](https://github.com/simonecorsi/mawesome/commit/285e193))
-* docs: added authors ([3de0e12](https://github.com/simonecorsi/mawesome/commit/3de0e12))
-* docs: added readme ([e1c9ca0](https://github.com/simonecorsi/mawesome/commit/e1c9ca0))
-* docs: readme updated ([192aa8a](https://github.com/simonecorsi/mawesome/commit/192aa8a))
-* feat: better errors ([1700aa3](https://github.com/simonecorsi/mawesome/commit/1700aa3))
-* feat: generate awesome list from stars ([0f6fa76](https://github.com/simonecorsi/mawesome/commit/0f6fa76))
-* feat: git user now is action ([aa70ac9](https://github.com/simonecorsi/mawesome/commit/aa70ac9))
-* ci: added github user setup ([a4bbd4b](https://github.com/simonecorsi/mawesome/commit/a4bbd4b))
-* ci: better release ([ea34727](https://github.com/simonecorsi/mawesome/commit/ea34727))
-* ci(version): prefixed now with v ([f3d2757](https://github.com/simonecorsi/mawesome/commit/f3d2757))
-* build: better releasing workflow ([ac6e274](https://github.com/simonecorsi/mawesome/commit/ac6e274))
-* build(index.js): build ([e007c3b](https://github.com/simonecorsi/mawesome/commit/e007c3b))
-* Initial commit ([e884018](https://github.com/simonecorsi/mawesome/commit/e884018))
 
 
 

README.md

@@ -1,20 +1,41 @@
-# My Awesome list
+# My Awesome List
 
-This action query the github api to get starred list of the user and then generates a list ordered by languages. 
+This action query the github api to get starred list of the user and then generates a list ordered by languages.
 
 You can see an example of the output at my own [simonecorsi/awesome](https://github.com/simonecorsi/awesome)
 
-## Setup
+## Table of Contents
 
-To use this action you have to create your own repository (eg: `yourname/awesome`), then create a new empty action in it and then use the [example workflow](#example-workflow) below as a starting point.
+<!-- toc -->
 
-## Inputs
+- [Table of Contents](#table-of-contents)
+- [Documentation](#documentation)
+  - [Requirements](#requirements)
+  - [Configuration](#configuration)
+    - [`api-token`](#api-token)
+- [Example workflow](#example-workflow)
 
-### `github-token`
+<!-- tocstop -->
 
-The github workflow token is mandatory 
+## Documentation
 
-### `api-token`
+### Requirements
+
+-   An empty repository
+-   A personal github api key
+
+### Configuration
+
+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 |
+
+#### `api-token`
 
 The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits.
 
@@ -36,8 +57,11 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Awesome generator
-        uses: simonecorsi/mawesome@lastest
+        uses: simonecorsi/mawesome@latest
         with:
           api-token: ${{ secrets.API_TOKEN }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-email: ${{ secrets.USER_EMAIL }}
+          github-name: ${{ github.repository_owner }}
+
 ```

action.yml

@@ -10,6 +10,10 @@ inputs:
   api-token:
     description: 'Personal API Token'
     required: true
+  github-name:
+    description: 'Name shown in the commit'
+  github-email:
+    description: 'Email shown in the commit'
 runs:
   using: 'node12'
   main: 'index.js'

index.js

@@ -18482,7 +18482,7 @@ const testParameter = (name, filters) => {
 };
 
 const normalizeDataURL = (urlString, {stripHash}) => {
-	const parts = urlString.match(/^data:(.*?),(.*?)(?:#(.*))?$/);
+	const parts = urlString.match(/^data:([^,]*?),([^#]*?)(?:#(.*))?$/);
 
 	if (!parts) {
 		throw new Error(`Invalid URL: ${urlString}`);
@@ -21308,9 +21308,11 @@ class Git {
         this.createTag = (tag) => this.exec(`tag -a ${tag} -m "${tag}"`);
         const githubToken = core.getInput('github-token', { required: true });
         core.setSecret(githubToken);
+        const githubName = core.getInput('github-name') || 'GitHub Actions';
+        const githubEmail = core.getInput('github-email') || 'actions@users.noreply.github.com';
         // Set config
-        this.config('user.name', 'GitHub Actions');
+        this.config('user.name', githubName);
-        this.config('user.email', 'actions@users.noreply.github.com');
+        this.config('user.email', githubEmail);
         this.config('pull.rebase', 'false');
         // Update the origin
         this.updateOrigin(`https://x-access-token:${githubToken}@github.com/${GITHUB_REPOSITORY}.git`);
@@ -21359,7 +21361,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.pushNewFile = exports.OUTPUT_FILENAME = exports.generateMd = exports.paginate = exports.API_STARRED_URL = exports.REPO_USERNAME = exports.apiGetStar = exports.renderer = exports.isLastPage = exports.wait = void 0;
+exports.pushNewFiles = exports.MARKDOWN_FILENAME = exports.generateMd = exports.paginate = exports.API_STARRED_URL = exports.REPO_USERNAME = exports.apiGetStar = exports.renderer = exports.isLastPage = exports.wait = void 0;
 const ejs_1 = __importDefault(__nccwpck_require__(8431));
 const core = __importStar(__nccwpck_require__(2186));
 const remark_1 = __importDefault(__nccwpck_require__(2081));
@@ -21431,17 +21433,21 @@ function generateMd(data) {
     });
 }
 exports.generateMd = generateMd;
-exports.OUTPUT_FILENAME = core.getInput('output-filename') || 'README.md';
+exports.MARKDOWN_FILENAME = core.getInput('output-filename') || 'README.md';
-function pushNewFile(markdown) {
+function pushNewFiles(files = []) {
     return __awaiter(this, void 0, void 0, function* () {
-        yield fsp.writeFile(exports.OUTPUT_FILENAME, markdown);
+        if (!files.length)
+            return;
         yield git_1.default.pull();
-        yield git_1.default.add(exports.OUTPUT_FILENAME);
+        yield Promise.all(files.map(({ filename, data }) => __awaiter(this, void 0, void 0, function* () {
-        yield git_1.default.commit(`chore(${exports.OUTPUT_FILENAME}): updated ${exports.OUTPUT_FILENAME}`);
+            yield fsp.writeFile(filename, data);
+            yield git_1.default.add(filename);
+            yield git_1.default.commit(`chore(${filename}): updated ${filename}`);
+        })));
         yield git_1.default.push();
     });
 }
-exports.pushNewFile = pushNewFile;
+exports.pushNewFiles = pushNewFiles;
 
 
 /***/ }),
@@ -21509,7 +21515,16 @@ function main() {
             updatedAt: Date.now(),
         });
         const markdown = yield helpers_1.generateMd(rendered);
-        yield helpers_1.pushNewFile(markdown);
+        yield helpers_1.pushNewFiles([
+            {
+                filename: helpers_1.MARKDOWN_FILENAME,
+                data: markdown,
+            },
+            {
+                filename: 'data.json',
+                data: JSON.stringify(sortedByLanguages, null, 2),
+            },
+        ]);
     });
 }
 exports.main = main;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mawesome",
-  "version": "1.0.28",
+  "version": "1.0.39",
   "description": "Generate awesome list from user starred repositories",
   "main": "index.js",
   "author": "Simone Corsi<simonecorsi.dev@gmail.com>",
@@ -12,7 +12,7 @@
     "style:prettier": "prettier \"src/**/*.ts\" --list-different --write",
     "build": "./node_modules/.bin/ncc build src/index.ts -o ./",
     "dev": "ts-node-dev src/index.ts",
-    "prerelease": "npm run build && "
+    "prerelease": "npm run build"
   },
   "keywords": [
     "github",
@@ -37,7 +37,6 @@
     "@vercel/ncc": "^0.26.2",
     "ava": "^3.8.2",
     "benchmark": "^2.1.4",
-    "conventional-gitlab-releaser": "^4.0.1",
     "cz-conventional-changelog": "^3.2.0",
     "eslint": "^7.17.0",
     "eslint-config-prettier": "^7.1.0",
@@ -46,7 +45,6 @@
     "husky": "^4.2.5",
     "lint-staged": "^10.2.2",
     "markdown-toc": "^1.2.0",
-    "ninos": "^3.0.0",
     "nyc": "^15.0.1",
     "prettier": "^2.0.5",
     "sinon": "^9.2.3",
@@ -57,7 +55,6 @@
   "dependencies": {
     "@actions/exec": "^1.0.4",
     "@actions/core": "^1.2.6",
-    "@actions/github": "^4.0.0",
     "ejs": "^3.1.5",
     "got": "^11.8.1",
     "remark": "^13.0.0",

src/git.ts

@@ -11,9 +11,13 @@ class Git {
     const githubToken = core.getInput('github-token', { required: true });
     core.setSecret(githubToken);
 
+    const githubName = core.getInput('github-name') || 'GitHub Actions';
+    const githubEmail =
+      core.getInput('github-email') || 'actions@users.noreply.github.com';
+
     // Set config
-    this.config('user.name', 'GitHub Actions');
+    this.config('user.name', githubName);
-    this.config('user.email', 'actions@users.noreply.github.com');
+    this.config('user.email', githubEmail);
     this.config('pull.rebase', 'false');
 
     // Update the origin

src/helpers.ts

@@ -77,12 +77,26 @@ export function generateMd(data: string): Promise<string> {
   });
 }
 
-export const OUTPUT_FILENAME: string =
+export const MARKDOWN_FILENAME: string =
   core.getInput('output-filename') || 'README.md';
-export async function pushNewFile(markdown: string): Promise<any> {
+
-  await fsp.writeFile(OUTPUT_FILENAME, markdown);
+type File = {
+  filename: string;
+  data: string;
+};
+
+export async function pushNewFiles(files: File[] = []): Promise<any> {
+  if (!files.length) return;
+
   await git.pull();
-  await git.add(OUTPUT_FILENAME);
+
-  await git.commit(`chore(${OUTPUT_FILENAME}): updated ${OUTPUT_FILENAME}`);
+  await Promise.all(
+    files.map(async ({ filename, data }) => {
+      await fsp.writeFile(filename, data);
+      await git.add(filename);
+      await git.commit(`chore(${filename}): updated ${filename}`);
+    })
+  );
+
   await git.push();
 }

src/index.ts

@@ -1,11 +1,13 @@
 import * as core from '@actions/core';
+import { data } from 'remark';
 
 import {
   renderer,
   paginate,
   REPO_USERNAME,
   generateMd,
-  pushNewFile,
+  pushNewFiles,
+  MARKDOWN_FILENAME,
 } from './helpers';
 
 import type { SortedLanguageList, Stars, Star } from './types';
@@ -41,7 +43,16 @@ export async function main(): Promise<any> {
 
   const markdown: string = await generateMd(rendered);
 
-  await pushNewFile(markdown);
+  await pushNewFiles([
+    {
+      filename: MARKDOWN_FILENAME,
+      data: markdown,
+    },
+    {
+      filename: 'data.json',
+      data: JSON.stringify(sortedByLanguages, null, 2),
+    },
+  ]);
 }
 
 export async function run(): Promise<any> {

test/helpers.spec.ts

@@ -38,7 +38,7 @@ import {
   apiGetStar,
   paginate,
   generateMd,
-  pushNewFile,
+  pushNewFiles,
 } from '../src/helpers';
 
 test('wait should wait', async (t) => {
@@ -97,7 +97,7 @@ test('generateMd should create TOC', async (t) => {
 });
 
 test('should push', async (t) => {
-  await pushNewFile('# title');
+  await pushNewFiles([{filename: "README.md", data: '# title'}]);
   t.true(writeFile.calledWith('README.md', '# title'));
   t.true(pull.called);
   t.true(add.calledWith('README.md'));