typescript-github-action-template 0.1.18 → 0.2.0

package/README.md

@@ -1,3 +1,11 @@
-# typescript-github-action-template
+# Typescript GitHub Action Template
 
 A template to create custom GitHub Action with TypeScript/JavaScript.
+
+## Secrets
+
+The following secrets need to be set up before you can use workflows already defined in this template:
+
+- **`CHECK_GIT_STATUS_BOT_APP_ID`** and **`CHECK_GIT_STATUS_BOT_APP_PRIVATE_KEY`**: Used by the [`Build` workflow](https://github.com/CatChen/typescript-github-action-template/blob/main/.github/workflows/build.yml). If you don't want to set up a bot you can remove the `actions/create-github-app-token` step and remove all references to `steps.get-github-app-token.outputs.token`.
+- **`ACCEPT_TO_SHIP_BOT_APP_ID`** and **`ACCEPT_TO_SHIP_BOT_APP_PRIVATE_KEY`**: Used by the [`Ship` workflow](https://github.com/CatChen/typescript-github-action-template/blob/main/.github/workflows/ship.yml). If you don't want to set up a bot you can remove the two `actions/create-github-app-token` steps and remove all references to `steps.get-github-app-token.outputs.token`.
+- **`NPM_TOKEN`**: Used by the [`Release` workflow](https://github.com/CatChen/typescript-github-action-template/blob/main/.github/workflows/release.yml). This is necessary for publishing the NPM package to NPM. If you don't want to publish to NPM you can remove the `publish` job.

package/dist/getOctokit.d.ts

@@ -0,0 +1,6 @@
+import { type Octokit } from '@octokit/core/dist-types/index.js';
+import { type PaginateInterface } from '@octokit/plugin-paginate-rest';
+import { type Api } from '@octokit/plugin-rest-endpoint-methods/dist-types/types.js';
+export declare function getOctokit(githubToken: string): Octokit & Api & {
+    paginate: PaginateInterface;
+};

package/dist/getOctokit.js

@@ -0,0 +1,39 @@
+import { GitHub, getOctokitOptions } from '@actions/github/lib/utils.js';
+import { retry } from '@octokit/plugin-retry';
+import { throttling } from '@octokit/plugin-throttling';
+export function getOctokit(githubToken) {
+    const Octokit = GitHub.plugin(throttling, retry);
+    const octokit = new Octokit(getOctokitOptions(githubToken, {
+        throttle: {
+            onRateLimit: (retryAfter, options, _, retryCount) => {
+                if (retryCount === 0) {
+                    octokit.log.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
+                    octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+                    return true;
+                }
+                else {
+                    octokit.log.error(`Request quota exhausted for request ${options.method} ${options.url}`);
+                }
+            },
+            onSecondaryRateLimit: (retryAfter, options, _, retryCount) => {
+                if (retryCount === 0) {
+                    octokit.log.warn(`Abuse detected for request ${options.method} ${options.url}`);
+                    octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+                    return true;
+                }
+                else {
+                    octokit.log.warn(`Abuse detected for request ${options.method} ${options.url}`);
+                }
+            },
+        },
+        retry: {
+            doNotRetry: ['429'],
+        },
+    }));
+    octokit.graphql = octokit.graphql.defaults({
+        headers: {
+            'X-GitHub-Next-Global-ID': 1,
+        },
+    });
+    return octokit;
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare function getLogin(githubToken: string): Promise<string>;

package/dist/index.js

@@ -0,0 +1,45 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { error, getInput, getState, notice, saveState, setFailed, } from '@actions/core';
+import { getOctokit } from './getOctokit.js';
+export function getLogin(githubToken) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const octokit = getOctokit(githubToken);
+        const { viewer: { login }, } = yield octokit.graphql(`
+      query {
+        viewer {
+          login
+        }
+      }
+    `, {});
+        return login;
+    });
+}
+function run() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const githubToken = getInput('github-token');
+        const login = yield getLogin(githubToken);
+        saveState('login', login);
+        notice(`Hello, ${login}!`);
+        error('Please implement this Action.');
+    });
+}
+function cleanup() {
+    const login = getState('login');
+    notice(`Goodbye, ${login}!`);
+    error('Please implemented or removed Action cleanup.');
+}
+if (!getState('isPost')) {
+    saveState('isPost', 'true');
+    run().catch((error) => setFailed(error));
+}
+else {
+    cleanup();
+}

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "typescript-github-action-template",
-  "version": "0.1.18",
+  "version": "0.2.0",
   "description": "A template to create custom GitHub Action with TypeScript/JavaScript.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
   "type": "module",
   "scripts": {
-    "build": "rm -rf lib && yarn tsc",
-    "package": "rm -rf dist && yarn ncc build src/index.ts --external eslint --source-map --license licenses.txt",
+    "build": "rm -rf dist && yarn tsc",
+    "bundle": "rm -rf bundle && yarn ncc build src/index.ts --external eslint --source-map --license licenses.txt --out bundle",
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "eslint -c eslint.config.js",
-    "postinstall": "is-ci || husky install",
-    "preversion": "rm -rf lib && rm -rf dist && yarn && yarn build && yarn package"
+    "_postinstall": "is-ci || husky install",
+    "prepublishOnly": "pinst --disable && yarn build",
+    "postpublish": "pinst --enable",
+    "preversion": "yarn && yarn build && yarn bundle"
   },
   "repository": {
     "type": "git",
@@ -27,7 +29,7 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.0.2",
     "@eslint/js": "^9.2.0",
-    "@trivago/prettier-plugin-sort-imports": "^4.0.0",
+    "@serverless-guru/prettier-plugin-import-order": "^0.4.2",
     "@types/node": "^20.1.0",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
     "@typescript-eslint/parser": "^7.0.1",
@@ -38,13 +40,16 @@
     "husky": "^9.0.5",
     "is-ci": "^3.0.1",
     "lint-staged": "^15.0.2",
+    "pinst": "^3.0.0",
     "prettier": "^3.0.2",
     "typescript": "^5.0.2",
     "typescript-eslint": "^7.8.0"
   },
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@actions/github": "^6.0.0"
+    "@actions/github": "^6.0.0",
+    "@octokit/plugin-retry": "^7.1.1",
+    "@octokit/plugin-throttling": "^9.3.0"
   },
   "lint-staged": {
     "*.(ts,js)": "yarn lint --fix",

package/.prettierrc.json

@@ -1,21 +0,0 @@
-{
-  "arrowParens": "always",
-  "bracketSpacing": true,
-  "bracketSameLine": false,
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "importOrder": [
-    "^node:(.*)$",
-    "^@action/core/(.*)$",
-    "^@action/github/(.*)$",
-    "^@action/exec/(.*)$",
-    "^@action/glob/(.*)$",
-    "^@action/(.*)$",
-    "<THIRD_PARTY_MODULES>",
-    "^[./]"
-  ],
-  "importOrderSeparation": true,
-  "importOrderSortSpecifiers": true
-}

package/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "yaml.schemas": {
-    "https://json.schemastore.org/github-action.json": "action.yml",
-    "https://json.schemastore.org/github-funding.json": ".github/FUNDING.yml",
-    "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml",
-    "https://json.schemastore.org/package.json": "package.json",
-    "https://json.schemastore.org/tsconfig.json": "tsconfig.json",
-    "https://json.schemastore.org/eslintrc.json": ".eslintrc.json",
-    "https://json.schemastore.org/prettierrc.json": ".prettierrc.json"
-  }
-}

package/eslint.config.js

@@ -1,45 +0,0 @@
-import js from '@eslint/js';
-import { FlatCompat } from '@eslint/eslintrc';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import ts from 'typescript-eslint';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  resolvePluginsRelativeTo: __dirname,
-  recommendedConfig: js.configs.recommended,
-});
-
-export default ts.config(
-  ...compat.config({
-    env: {
-      browser: true,
-      es2022: true,
-      node: true,
-    },
-    extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-      project: './tsconfig.json',
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-    },
-    root: true,
-    rules: {},
-    ignorePatterns: [
-      'node_modules/**/*',
-      'lib/**/*',
-      'dist/**/*',
-      'eslint.config.js',
-    ],
-    overrides: [
-      {
-        files: ['*.ts'],
-      },
-    ],
-  }),
-  ...ts.configs.recommendedTypeChecked,
-);

package/lib/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/index.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@actions/core");
-const github_1 = require("@actions/github");
-function run() {
-    if (!(0, core_1.getState)('isPost')) {
-        (0, core_1.saveState)('isPost', 'true');
-    }
-    (0, core_1.info)(`This is the Action context: ${JSON.stringify(github_1.context)}`);
-    (0, core_1.error)('Action needs to be implemented.');
-}
-function cleanup() {
-    (0, core_1.error)('Post action needs to be implemented or removed.');
-}
-if (!(0, core_1.getState)('isPost')) {
-    run();
-}
-else {
-    cleanup();
-}