chore(release): 2.2.0-next.1 [skip ci]

# [2.2.0-next.1](https://github.com/simonecorsi/mawesome/compare/v2.1.0...v2.2.0-next.1) (2022-07-06)

### Features

* adds compacted by topics ([9dfa1f3](9dfa1f3dae))

CHANGELOG.md

@@ -1,3 +1,22 @@
+# [2.2.0-next.1](https://github.com/simonecorsi/mawesome/compare/v2.1.0...v2.2.0-next.1) (2022-07-06)
+
+
+### Features
+
+* adds compacted by topics ([9dfa1f3](https://github.com/simonecorsi/mawesome/commit/9dfa1f3dae6c69033c682211c0e6bd9dc5a81eaf))
+
+# [2.1.0](https://github.com/simonecorsi/mawesome/compare/v2.0.0...v2.1.0) (2022-05-11)
+
+
+### Bug Fixes
+
+* removes console.log ([7841262](https://github.com/simonecorsi/mawesome/commit/7841262e741f05debb7ffe6fed636a508a8f7c12))
+
+
+### Features
+
+* removes github-token need ([0dc2a51](https://github.com/simonecorsi/mawesome/commit/0dc2a51ddf3cf93414afd674ed3c34ec681f3e4b))
+
 # [2.0.0](https://github.com/simonecorsi/mawesome/compare/v1.0.45...v2.0.0) (2022-05-11)
 
 

README.md

@@ -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,13 @@ 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 output template file ([EJS](https://ejs.co/) template engine) | [TEMPLATE.ejs](./TEMPLATE.ejs)   |
-| `output-filename` | Output filename                                                      | `README.md`                      |
+| Variable          | Description                                                         | Default                          |
+| ----------------- | ------------------------------------------------------------------- | -------------------------------- |
+| `api-token`       | Personal Token is used to avoid rate limit, [read more](#api-token) | `${{ secrets.API_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 +42,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

action.yml

@@ -4,9 +4,10 @@ branding:
   icon: align-justify
   color: yellow
 inputs:
-  github-token:
-    description: 'Github token'
-    required: true
+  compact-by-topic:
+    description: 'Generate another page with output compacted by github topics'
+    default: 'false'
+    required: false
   api-token:
     description: 'Personal API Token'
     required: true

package.json

@@ -22,8 +22,8 @@
     "javascript"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^16.2.4",
-    "@commitlint/config-conventional": "^16.2.4",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
     "@octokit/rest": "^18.12.0",
     "@octokit/types": "^6.2.1",
     "@saithodev/semantic-release-backmerge": "^2.1.2",
@@ -32,31 +32,31 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^8.0.4",
     "@semantic-release/release-notes-generator": "^10.0.3",
-    "@types/ejs": "^3.1.0",
+    "@types/ejs": "^3.1.1",
     "@types/got": "^9.6.12",
-    "@types/node": "^17.0.32",
+    "@types/node": "^17.0.41",
     "@types/sinon": "^10.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.23.0",
-    "@typescript-eslint/parser": "^5.23.0",
-    "@vercel/ncc": "^0.33.4",
-    "eslint": "^8.15.0",
+    "@typescript-eslint/eslint-plugin": "^5.27.1",
+    "@typescript-eslint/parser": "^5.27.1",
+    "@vercel/ncc": "^0.34.0",
+    "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^8.0.1",
-    "lint-staged": "^12.4.1",
+    "lint-staged": "^13.0.1",
     "markdown-toc": "^1.2.0",
     "nyc": "^15.0.1",
     "prettier": "^2.6.2",
     "sinon": "^14.0.0",
-    "ts-node-dev": "^1.1.8",
-    "typescript": "^4.6.4"
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^4.7.3"
   },
   "dependencies": {
-    "@actions/core": "^1.8.0",
+    "@actions/core": "^1.8.2",
     "@actions/exec": "^1.1.1",
-    "ejs": "^3.1.7",
-    "gh-star-fetch": "^1.3.0",
+    "ejs": "^3.1.8",
+    "gh-star-fetch": "^1.5.0",
     "got": "^11.8.1",
     "remark": "^14.0.2",
     "remark-toc": "^8.0.1"

src/git.ts

@@ -15,7 +15,7 @@ type File = {
 
 class Git {
   constructor() {
-    const githubToken = core.getInput('github-token', { required: true });
+    const githubToken = core.getInput('api-token', { required: true });
     core.setSecret(githubToken);
 
     const githubName = core.getInput('github-name') || 'GitHub Actions';

src/index.ts

@@ -1,7 +1,11 @@
 import path from 'path';
 import * as core from '@actions/core';
 import { readFile } from 'fs/promises';
-import ghStarFetch from 'gh-star-fetch';
+import ghStarFetch, {
+  Options,
+  compactByLanguage,
+  compactByTopic,
+} from 'gh-star-fetch';
 
 import {
   renderer,
@@ -27,33 +31,56 @@ export async function main() {
     core.info("Couldn't find template file, using default");
   }
 
-  const sortedByLanguages = await ghStarFetch({
+  const opts: Partial<Options> = {
     accessToken: core.getInput('api-token', { required: true }),
-    compactByLanguage: true,
-  });
-  console.log('sortedByLanguages :>> ', sortedByLanguages);
+  };
 
-  const rendered = await renderer(
+  const results = await ghStarFetch(opts);
+
+  const files = [];
+
+  const compactedByLanguage = compactByLanguage(results);
+  const byLanguage = await renderer(
     {
       username: REPO_USERNAME,
-      stars: Object.entries(sortedByLanguages),
+      stars: Object.entries(compactedByLanguage),
       updatedAt: Date.now(),
     },
     template
   );
 
-  const markdown: string = await generateMd(rendered);
-
-  await git.pushNewFiles([
+  files.push(
     {
       filename: MARKDOWN_FILENAME,
-      data: markdown,
+      data: await generateMd(byLanguage),
     },
     {
       filename: 'data.json',
-      data: JSON.stringify(sortedByLanguages, null, 2),
-    },
-  ]);
+      data: JSON.stringify(compactedByLanguage, null, 2),
+    }
+  );
+
+  const shouldCompactByTopic =
+    !!core.getInput('compact-by-topic') ||
+    core.getInput('compact-by-topic') === 'true';
+
+  if (shouldCompactByTopic) {
+    const compactedByTopic = compactByTopic(results);
+    const byTopic = await renderer(
+      {
+        username: REPO_USERNAME,
+        stars: Object.entries(compactedByTopic),
+        updatedAt: Date.now(),
+      },
+      template
+    );
+    files.push({
+      filename: 'TOPICS.md',
+      data: await generateMd(byTopic),
+    });
+  }
+
+  await git.pushNewFiles(files);
 }
 
 export async function run(): Promise<void> {