typescript-github-action-template 0.1.17 → 0.1.19

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-github-action-template",
-  "version": "0.1.17",
+  "version": "0.1.19",
   "description": "A template to create custom GitHub Action with TypeScript/JavaScript.",
   "main": "lib/index.js",
   "types": "lib/index.d.js",
@@ -10,8 +10,10 @@
     "package": "rm -rf dist && yarn ncc build src/index.ts --external eslint --source-map --license licenses.txt",
     "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",
+    "postpublish": "pinst --enable",
+    "preversion": "yarn && yarn build && yarn package"
   },
   "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,6 +40,7 @@
     "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"

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,
-);