PS C:\Code\Git\algorithms> git commit -m "这是一个不符合规范的 Commit Message"husky > commit-msg (node v12.13.1)⧗ input: 这是一个不符合规范的 Commit Message✖ subject may not be empty [subject-empty]✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warningsⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
husky > commit-msg hook failed (add --no-verify to bypass)

{ "compilerOptions": { // 指定 ECMAScript 目标版本 "ES3"（默认）， "ES5"， "ES6" / "ES2015"， "ES2016"， "ES2017" 或 "ESNext"。 "target": "ES5", // 构建的目标代码删除所有注释，除了以 /!* 开头的版权信息 "removeComments": true, // 可配合 gulp-typescript 生成相应的 .d.ts 文件 "declaration": true, // 启用所有严格类型检查选项。启用 --strict 相当于启用 --noImplicitAny, --noImplicitThis, --alwaysStrict， --strictNullChecks, --strictFunctionTypes 和 --strictPropertyInitialization "strict": true, // 禁止对同一个文件的不一致的引用 "forceConsistentCasingInFileNames": true, // 报错时不生成输出文件 "noEmitOnError": true }}

const gulp = require("gulp");const ts = require("gulp-typescript");const tsProject = ts.createProject("tsconfig.json");
// 输出 CommonJS 规范到 dist 目录下gulp.task("default", function () { const tsResult = tsProject.src().pipe(tsProject()); return tsResult.js.pipe(gulp.dest("dist"));});

"scripts": { "build": "rimraf dist && gulp"},

const gulp = require("gulp");const ts = require("gulp-typescript");const tsProject = ts.createProject("tsconfig.json");const merge = require("merge2");
// 输出 CommonJS 规范到 dist 目录下gulp.task("default", function () { const tsResult = tsProject.src().pipe(tsProject());
 return merge([ tsResult.dts.pipe(gulp.dest("types")), tsResult.js.pipe(gulp.dest("dist")), ]);});

"scripts": { "build": "rimraf dist types && gulp",},

"files": [ "dist", "types"],

"main": "dist/index.js"

npm i --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin

module.exports = { root: true, parser: "@typescript-eslint/parser", plugins: ["@typescript-eslint"], extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],};

"scripts": { "lint": "eslint src",}

> eslint src

C:\Code\Git\algorithms\src\greet.ts 2:16 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types
✖ 1 problem (0 errors, 1 warning)

# gulpgulpfile.js
# eslint.eslintrc.js
# commitizencommitlint.config.js
# jestjest.config.js
# builddist

"editor.codeActionsOnSave": { "source.fixAll": true, "source.fixAll.eslint": true}

"scripts": { "lint": "eslint src --max-warnings 0", "build": "npm run lint && rimraf dist types && gulp",}

npm i prettier eslint-config-prettier --save-dev

{ "extends": [ "plugin:@typescript-eslint/recommended", // 用于关闭 ESLint 相关的格式规则集，具体可查看 https://github.com/prettier/eslint-config-prettier/blob/master/index.js "prettier", // 用于关闭 @typescript-eslint/eslint-plugin 插件相关的格式规则集，具体可查看 https://github.com/prettier/eslint-config-prettier/blob/master/%40typescript-eslint.js "prettier/@typescript-eslint", ]}

"scripts": { "prettier": "prettier src test --write",},

import great from "@/greet";
// 中间这么多空行export default { great,};

PS C:\Code\Git\algorithms> npm run prettier
> [email protected] prettier C:\Code\Git\algorithms> prettier src test --write
src\greet.ts 149mssrc\index.ts 5mstest\greet.spec.ts 11ms

import great from "@/greet";
export default { great,};

PS C:\Code\Git\algorithms> npx eslint --print-config src/index.ts | npx eslint-config-prettier-checkNo rules that are unnecessary or conflict with Prettier were found.

PS C:\Code\Git\algorithms> npx eslint --print-config src/index.ts | npx eslint-config-prettier-checkThe following rules are unnecessary or might conflict with Prettier:
- @typescript-eslint/no-extra-semi- no-mixed-spaces-and-tabs
The following rules are enabled but cannot be automatically checked. See:https://github.com/prettier/eslint-config-prettier#special-rules
- no-unexpected-multiline

npx mrm lint-staged

// 我们的哈士奇再次上场，这次它是要咬着你的 ESLint 不放了，这里我简称它的动作为 "咬 💩" ~~~"husky": { "hooks": { "pre-commit": "lint-staged" }},"lint-staged": { // 这里需要注意 ESLint 脚本的 --max-warnings 0 // 否则就算存在 warning 也不会终止提交行为 // 这里追加了 Prettier 的自动格式化，确保代码提交之前所有的格式能够修复 "*.ts": ["npm run lint", "npm run prettier"]}

husky > pre-commit (node v12.13.1)[STARTED] Preparing...[SUCCESS] Preparing...[STARTED] Running tasks...[STARTED] Running tasks for *.ts[STARTED] npm run lint-strict[FAILED] npm run lint-strict [FAILED][FAILED] npm run lint-strict [FAILED][SUCCESS] Running tasks...[STARTED] Applying modifications...[SKIPPED] Skipped because of errors from tasks.[STARTED] Reverting to original state because of errors...[SUCCESS] Reverting to original state because of errors...[STARTED] Cleaning up...[SUCCESS] Cleaning up...
× npm run lint-strict:ESLint found too many warnings (maximum: 0).npm ERR! code ELIFECYCLEnpm ERR! errno 1npm ERR! [email protected] lint-strict: `eslint src --max-warnings 0 "C:/Code/Git/algorithms/src/greet.ts"`npm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] lint-strict script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-11T07_25_39_102Z-debug.log
> [email protected] lint-strict C:\Code\Git\algorithms> eslint src --max-warnings 0 "C:/Code/Git/algorithms/src/greet.ts"

C:\Code\Git\algorithms\src\greet.ts 2:16 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types 2:34 warning Argument 'name' should be typed @typescript-eslint/explicit-module-boundary-types
✖ 2 problems (0 errors, 2 warnings)
husky > pre-commit hook failed (add --no-verify to bypass)

PS C:\Code\Git\algorithms> git commit -m "这是一个不符合规范的 Commit Message"// pre-commit 钩子 ESLint 校验通过husky > pre-commit (node v12.13.1)[STARTED] Preparing...[SUCCESS] Preparing...[STARTED] Running tasks...[STARTED] Running tasks for *.ts[STARTED] npm run lint-strict[SUCCESS] npm run lint-strict[SUCCESS] Running tasks for *.ts[SUCCESS] Running tasks...[STARTED] Applying modifications...[SUCCESS] Applying modifications...[STARTED] Cleaning up...[SUCCESS] Cleaning up...// commit-msg 钩子 Git Commit Message 校验失败husky > commit-msg (node v12.13.1)⧗ input: 这是一个不符合规范的 Commit Message✖ subject may not be empty [subject-empty]✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warningsⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
husky > commit-msg hook failed (add --no-verify to bypass)

npm install --save-dev jest typescript ts-jest @types/jestnpx ts-jest config:init

module.exports = { preset: "ts-jest", testEnvironment: "node", // 输出覆盖信息文件的目录 coverageDirectory: "./coverage/", // 覆盖信息的忽略文件模式 testPathIgnorePatterns: ["<rootDir>/node_modules/"], // 如果测试覆盖率未达到 100%，则测试失败 // 这里可用于预防代码构建和提交 coverageThreshold: { global: { branches: 100, functions: 100, lines: 100, statements: 100, }, }, // 路径映射配置，具体可查看 https://kulshekhar.github.io/ts-jest/user/config/#paths-mapping // 需要配合 TypeScript 路径映射，具体可查看：https://www.tslang.cn/docs/handbook/module-resolution.html moduleNameMapper: { "^@/(.*)$": "<rootDir>/src/$1", },};

"scripts": { "lint": "eslint src --max-warnings 0", "test": "jest --bail --coverage", "build": "npm run lint && npm run jest && rimraf dist types && gulp",}

import greet from "@/greet";
describe("src/greet.ts", () => { it("name param test", () => { expect(greet("world")).toBe("Hello from world 1"); });});

PS C:\Code\Git\algorithms> npm run build
> [email protected] build C:\Code\Git\algorithms> npm run lint-strict && npm run jest && rimraf dist types && gulp

> [email protected] lint-strict C:\Code\Git\algorithms> eslint src --max-warnings 0

> [email protected] jest C:\Code\Git\algorithms> jest --coverage
 PASS dist/test/greet.spec.js FAIL test/greet.spec.ts ● src/greet.ts › name param test
 expect(received).toBe(expected) // Object.is equality
 Expected: "Hello from world 1" Received: "Hello from world"
 3 | describe("src/greet.ts", () => { 4 | it("name param test", () => { > 5 | expect(greet("world")).toBe("Hello from world 1"); | ^ 6 | }); 7 | }); 8 |
 at Object.<anonymous> (test/greet.spec.ts:5:28)
----------|---------|----------|---------|---------|-------------------| File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s || ---------- | --------- | ---------- | --------- | --------- | ------------------- || All files | 100 | 100 | 100 | 100 || greet.ts | 100 | 100 | 100 | 100 || ---------- | --------- | ---------- | --------- | --------- | ------------------- |Test Suites: 1 failed, 1 passed, 2 totalTests: 1 failed, 1 passed, 2 totalSnapshots: 0 totalTime: 3.45 sRan all test suites.npm ERR! code ELIFECYCLEnpm ERR! errno 1npm ERR! [email protected] jest: `jest --coverage`npm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] jest script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-12T13_42_11_628Z-debug.lognpm ERR! code ELIFECYCLEnpm ERR! errno 1npm ERR! [email protected] build: `npm run lint-strict && npm run jest && rimraf dist types && gulp`npm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] build script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-12T13_42_11_673Z-debug.log

"scripts": { "lint": "eslint src --max-warnings 0", "test": "jest --bail --coverage",},"lint-staged": { "*.ts": [ "npm run lint", "npm run test" ]}

husky > pre-commit (node v12.13.1)[STARTED] Preparing...[SUCCESS] Preparing...[STARTED] Running tasks...[STARTED] Running tasks for *.ts[STARTED] npm run lint[SUCCESS] npm run lint[STARTED] npm run jest[FAILED] npm run jest [FAILED][FAILED] npm run jest [FAILED][SUCCESS] Running tasks...[STARTED] Applying modifications...[SKIPPED] Skipped because of errors from tasks.[STARTED] Reverting to original state because of errors...[SUCCESS] Reverting to original state because of errors...[STARTED] Cleaning up...[SUCCESS] Cleaning up...
× npm run jest:FAIL test/greet.spec.ts src/greet.ts × name param test (4 ms)
 ● src/greet.ts › name param test
 expect(received).toBe(expected) // Object.is equality
 Expected: "Hello from world 1" Received: "Hello from world"
 3 | describe("src/greet.ts", () => { 4 | it("name param test", () => { > 5 | expect(greet("world")).toBe("Hello from world 1"); | ^ 6 | }); 7 | }); 8 |
 at Object.<anonymous> (test/greet.spec.ts:5:28)
Test Suites: 1 failed, 1 totalTests: 1 failed, 1 totalSnapshots: 0 totalTime: 1.339 s, estimated 3 sRan all test suites related to files matching /C:\\Code\\Git\\algorithms\\src\\index.ts|C:\\Code\\Git\\algorithms\\test\\greet.spec.ts/i.npm ERR! code ELIFECYCLEnpm ERR! errno 1npm ERR! [email protected] jest: `jest --bail --findRelatedTests --coverage "C:/Code/Git/algorithms/src/index.ts" "C:/Code/Git/algorithms/test/greet.spec.ts"`npm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] jest script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-12T14_33_51_183Z-debug.log
> [email protected] jest C:\Code\Git\algorithmsnpm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] jest script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-12T14_33_51_183Z-debug.log
> [email protected] jest C:\Code\Git\algorithms> jest --bail --findRelatedTests --coverage "C:/Code/Git/algorithms/src/index.ts" "C:/Code/Git/algorithms/test/greet.spec.ts"
----------|---------|----------|---------|---------|-------------------| File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s || ---------- | --------- | ---------- | --------- | --------- | ------------------- || All files | 0 | 0 | 0 | 0 || ---------- | --------- | ---------- | --------- | --------- | ------------------- |husky > pre-commit hook failed (add --no-verify to bypass)git exited with error code 1

module.exports = { root: true, parser: "@typescript-eslint/parser", plugins: ["@typescript-eslint"], extends: [ "eslint:recommended", "plugin:@typescript-eslint/recommended", // 新增推荐的 ESLint 校验规则 // 所有规则集查看：https://github.com/jest-community/eslint-plugin-jest#rules（recommended 标识表明是推荐规则） "plugin:jest/recommended", ],};

import greet from "@/greet";describe("src/greet.ts", () => { it("name param test", () => { expect(greet("world")).toBe("Hello from world 1"); });});
// 这里输入了重复的 titledescribe("src/greet.ts", () => { it("name param test", () => { expect(greet("world")).toBe("Hello from world 1"); });});

"scripts": { // 这里对 src 和 test 目录进行 ESLint 校验 "lint": "eslint src test --max-warnings 0",},

PS C:\Code\Git\algorithms> npm run lint
> [email protected] lint C:\Code\Git\algorithms> eslint src test --max-warnings 0

C:\Code\Git\algorithms\test\greet.spec.ts 9:10 error Describe block title is used multiple times in the same describe block jest/no-identical-title
✖ 1 problem (1 error, 0 warnings)
npm ERR! code ELIFECYCLEnpm ERR! errno 1npm ERR! [email protected] lint: `eslint src test --max-warnings 0`npm ERR! Exit status 1npm ERR!npm ERR! Failed at the [email protected] lint script.npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:npm ERR! C:\Users\子弈\AppData\Roaming\npm-cache\_logs\2020-07-13T02_25_12_043Z-debug.log

"lint": "eslint src test --max-warnings 0","test": "jest --bail --coverage","build": "npm run lint && npm run prettier && npm run test && rimraf dist types && gulp","changelog": "rimraf CHANGELOG.md && conventional-changelog -p angular -i CHANGELOG.md -s"

"lint": "eslint src test --max-warnings 0","test": "jest --bail --coverage","prebuild": "npm run lint && npm run prettier && npm run test","build": "rimraf dist types && gulp","changelog": "rimraf CHANGELOG.md && conventional-changelog -p angular -i CHANGELOG.md -s"

npm run prebuild && npm run build

"scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs"}

.├── docs│ ├── .vuepress│ │ └── config.js # 配置文件│ └── README.md # 文档首页└── package.json

---home: true# heroImage: /hero.pngheroText: algorithms-utilstagline: 算法与 TypeScript 实现actionText: 开始学习actionLink: /guide/features: - title: 精简理论 details: 精简《算法导论》的内容，帮助自己更容易学习算法理论知识。 - title: 习题练习 details: 解答《算法导论》的习题，帮助自己更好的实践算法理论知识。 - title: 面题精选 details: 搜集常见的面试题目，提升自己的算法编程能力以及面试通过率。footer: MIT Licensed | Copyright © 2020-present 子弈---

const packageJson = require("../../package.json");
module.exports = { // 配置网站标题 title: packageJson.name, // 配置网站描述 description: packageJson.description, // 配置基本路径 base: "/algorithms/", // 配置基本端口 port: "8080",};

PS C:\Code\Git\algorithms> npm run docs:dev
> [email protected] docs:dev C:\Code\Git\algorithms> vuepress dev docs
wait Extracting site metadata...tip Apply theme @vuepress/theme-default ...tip Apply plugin container (i.e. "vuepress-plugin-container") ...tip Apply plugin @vuepress/register-components (i.e. "@vuepress/plugin-register-components") ...tip Apply plugin @vuepress/active-header-links (i.e. "@vuepress/plugin-active-header-links") ...tip Apply plugin @vuepress/search (i.e. "@vuepress/plugin-search") ...tip Apply plugin @vuepress/nprogress (i.e. "@vuepress/plugin-nprogress") ...
√ Client Compiled successfully in 5.31s
i ｢wds｣: Project is running at http://0.0.0.0:8080/i ｢wds｣: webpack output is served from /algorithms-utils/i ｢wds｣: Content not from webpack is served from C:\Code\Git\algorithms\docs\.vuepress\publici ｢wds｣: 404s will fallback to /index.htmlsuccess [23:13:14] Build 10b15a finished in 5311 ms!> VuePress dev server listening at http://localhost:8080/algorithms-utils/

const packageJson = require("../../package.json");const sidebar = require("./config/sidebar.js");const nav = require("./config/nav.js");const path = require("path");
module.exports = { title: packageJson.name, description: packageJson.description, base: "/algorithms/", port: "8080",
 themeConfig: { nav, sidebar, },
 plugins: [ "vuepress-plugin-cat", [ "mathjax", { target: "svg", macros: { "*": "\\times", }, }, ], // 增加 Markdown 文档对于 TypeScript 语法的支持 [ "vuepress-plugin-typescript", { tsLoaderOptions: { // ts-loader 的所有配置项 }, }, ], ],
 chainWebpack: (config) => { config.resolve.alias.set("image", path.resolve(__dirname, "public"));
 // 在文档中模拟库包的引入方式 // 例如发布了 algorithms-utils 库包之后， // import greet from 'algorithms-utils/greet.ts' 在 Vuepress 演示文档中等同于 // import greet from '~/src/greet.ts', // 其中 ~ 在这里只是表示项目根目录 config.resolve.alias.set( "algorithms-utils", path.resolve(__dirname, "../../src") ); },};

# Test vuepress
::: danger 测试 Vuepress引入 greet.ts 并进行调用测试。:::
<template> <collapse title="查看答案">{{msg}}</collapse></template>
<template> <div>{{msg}}</div></template>
<script lang="ts"> import greet from 'algorithms-utils/greet' const msg = greet('ziyi') export default { data() { return { msg } }, }</script>

# 以下都是官方文档的简单翻译# 当前的 yml（.yaml） 文件是一个 workflow，是持续集成一次运行的一个过程，必须放置在项目的 .github/workflow 目录下# 如果不清楚 .yml 文件格式语法，可以查看 https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes# 初次编写难免会产生格式问题，可以使用 VS Code 插件进行格式检测，https://marketplace.visualstudio.com/items?itemName=OmarTawfik.github-actions-vscode
# 具体各个配置属性可查看 https: //docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
# workflow 的执行仍然会受到一些限制，例如# - 每个 job 最多执行 6 小时（本地机器不受限制）# - 每个 workflow 最多执行 72 小时# - 并发 job 的数量会受到限制# - 更多查看 https: //docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#usage-limits
# name: 当前 workflow 的名称name: Algorithms
# on: 指定 workflow 触发的 event## event 有以下几种类型# - webhook# - scheduled# - manualon: # push: 一个 webhook event，用于提交代码时触发 workflow，也可以是触发列表，例如 [push, pull_request]
 # workflows 触发的 event 大部分是基于 webhook 配置，以下列举几个常见的 webhook: # - delete: 删除一个 branch 或 tag 时触发 # - fork / watch: 某人 fork / watch 项目时触发（你问有什么用，发送邮件通知不香吗？） # - pull_request: 提交 PR 时触发 # - page_build: 提交 Github Pages-enabled 分支代码时触发 # - push: 提交代码到特定分支时触发 # - registry_package: 发布或跟新 package 时触发 # 更多 webhook 可查看 https: //docs.github.com/en/actions/reference/events-that-trigger-workflows # 从这里可以看出 Git Actions 的一大特点就是 Gihub 官方提供的一系列 webhook push: # branches: 指定 push 触发的特定分支，这里你可以通过列表的形式指定多个分支 branches: - feat/framework # # branches 的指定可以是通配符类型，例如以下配置可以匹配 refs/heads/releases/10 # - 'releases/**' # # branches 也可以使用反向匹配，例如以下不会匹配 refs/heads/releases/10 # - '!releases/**' # # branches-ignore: 只对 [push, pull_request] 两个 webhook 起作用，用于指定当前 webhook 不触发的分支 # 需要注意在同一个 webhook 中不能和 branches 同时使用 # # tags: 只对 [push, pull_request] 两个 webhook 起作用，用于指定当前 webhook 触发的 tag # # tags: # - v1 # Push events to v1 tag # - v1.* # Push events to v1.0, v1.1, and v1.9 tags # # tags-ignore: 类似于 branches-ignore # # paths、paths-ignore... # # 更多关于特定过滤模式可查看 https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet # # 其他的 webhook 控制项还包括 types（不是所有的 webhook 都有 types），例如已 issues 为例，可以在 issues 被 open、reopened、closed 等情况下触发 workflow # 更多 webhook 的 types 可查看 https: //docs.github.com/en/actions/reference/events-that-trigger-workflows#webhook-events # # on: # issues: # types: [opened, edited, closed]
 # 除此之外如果对于每个分支有不同的 webhook 触发，则可以通过以下形式进行多个 webhook 配置 # # push: # branches: # - master # pull_request: # branches: # - dev # # 除了以上所说的 webhook event，还有 scheduled event 和 manual event # scheduled event: 用于定时构建，例如最小的时间间隔是 5 min 构建一次 # 具体可查看 https: //docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events
# env: 指定环境变量（所有的 job 生效，每一个 job 可以独立通过 jobs.<job_id>.env、jobs.<job_id>.steps.env 配置）# defaults / defaults.run: 所有的 job 生效，每一个 job 可以独立通过 jobs.<job_id>.defaults 配置# deafults# defaults.run
# jobs: 一个 workflow 由一个或多个 job 组成jobs: # job id: 是 job 的唯一标识，可以通过 _ 进行连接，例如: my_first_job，例如这里的 build 就是一个 job id build_and_deploy: # name: 在 Github 中显示的 job 名称 name: Build And Deploy # # needs: 用于继发执行 job，例如当前 job build 必须在 job1 和 job2 都执行成功的基础上执行 # needs: [job1, job2] # # runs-on: job 运行的环境配置，包括: # - windows-latest # - windows-2019 # - ubuntu-20.04 # - ubuntu-latest # - ubuntu-18.04 # - ubuntu-16.04 # - macos-latest # - macos-10.15 # - self-hosted（本地机器，具体可查看 https: //docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow） runs-on: ubuntu-latest # # outputs: 用于输出信息 # # env: 用于设置环境变量 # # defaults: 当前所有 step 的默认配置 # # defaults.run
 # if: 满足条件执行当前 job
 # steps: 一个 job 由多个 step 组成，step 可以 # - 执行一系列 tasks # - 执行命令 # - 执行 action # - 执行公共的 repository # - 在 Docker registry 中的 action steps: # # id: 类似于 job id # # if: 类似于 job if # # name: 当前 step 的名字 - name: Checkout # # uses: 用于执行 action # # action: 可以重复使用的单元代码 # - 为了 workflow 的安全和稳定建议指定 action 的发布版本或 commit SHA # - 使用指定 action 的 major 版本，这样可以允许你接收 fixs 以及 安全补丁并同时保持兼容性 # - 尽量不建议使用 master 版本，因为 master 很有可能会被发布新的 major 版本从而破坏了 action 的兼容性 # - action 可能是 JavaScript 文件或 Docker 容器，如果是 Docker 容器，那么 runs-on 必须指定 Linux 环境 # # 指定固定 commit SHA # uses: actions/setup-node@74bc508 # 指定一个 major 发布版本 # uses: actions/setup-node@v1 # 指定一个 minor 发布版本 # uses: actions/[email protected] # 指定一个分支 # uses: actions/setup-node@master # 指定一个 Github 仓库子目录的特定分支、ref 或 SHA # uses: actions/aws/ec2@master # 指定当前仓库所在 workflows 的目录地址 # uses: ./.github/actions/my-action # 指定在 Dock Hub 发布的 Docker 镜像地址 # uses: docker: //alpine: 3.8 # A Docker image in a public registry # uses: docker: //gcr.io/cloud-builders/gradle
 # checkout action 主要用于向 github 仓库拉取源代码（需要注意 workflow 是运行在服务器上，因此需要向当前 github 拉取仓库源代码） # 它的功能包括但不限于 # - Fetch all history for all tags and branches # - Checkout a different branch # - Checkout HEAD^ # - Checkout multiple repos (side by side) # - Checkout multiple repos (nested) # - Checkout multiple repos (private) # - Checkout pull request HEAD commit instead of merge commit # - Checkout pull request on closed event # - Push a commit using the built-in token
 # checkout action: https: //github.com/actions/checkout uses: actions/checkout@v2 # with: action 提供的输入参数 with: # 指定 checkout 的分支、tag 或 SHA # 更多 checkout action 的配置可查看 https: //github.com/actions/checkout#usage ref: feat/ci # args: 用于 Docker 容器的 CMD 指令参数 # entrypoint: Docker 容器 action（覆盖 Dockerfile 的 ENTRYPOINT） 和 JavaScript action 都可以使用 # # run: 使用当前的操作系统的默认的 non-login shell 执行命令行程序 # 运行单个脚本 # run: npm install # 运行多个脚本 # run: | # npm ci # npm run build # # working-directory: 用于指定当前脚本运行的目录 # working-directory: ./temp # # shell: 可以指定 shell 类型进行执行，例如 bash、pwsh、python、sh、cmd、powershell # shell: bash # # env: 除了可以设置 workflow 以及 job 的 env，也可以设置 step 的 env（可以理解为作用域不同，局部作用域的优先级更高） # # comtinue-on-error: 默认当前 step 失败则会阻止当前 job 继续执行，设置 true 时当前 step 失败则可以跳过当前 job 的执行
 - name: Cache # cache action: https://github.com/actions/cache # cache 在这里主要用于缓存 npm，提升构建速率 uses: actions/cache@v2 # npm 缓存的路径可查看 https://docs.npmjs.com/cli/cache#cache # 由于这里 runs-on 是 ubuntu-latest，因此配置 ~/.npm with: path: ~/.npm key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- # github-script action: https://github.com/actions/github-script # 在 workflow 中使用 Script 语法调用 Github API 或引用 workflow context
 # setup-node action: https://github.com/actions/setup-node # 配置 Node 执行环境（当前构建的服务器默认没有 Node 环境，可以通过 Action 安装 Node） # 需要注意安装 Node 的同时会捆绑安装 npm，如果想了解为什么会捆绑，可以 Google 一下有趣的故事哦 # 因此使用了该 action 后就可以使用 npm 的脚本在服务器进行执行啦 # 这里也可以尝试 v2-beta 版本哦 - name: Set Node uses: actions/setup-node@v1 with: # 也可以通过 strategy.matrix.node 进行灵活配置 # 这里本地使用 node 的 12 版本构建，因此这里就进行版本固定啦 node-version: "12"
 - run: npm install - run: npm run build - run: npm run docs:build
 - name: Deploy # 用于发布静态站点资源 # actions-gh-pages action: https://github.com/peaceiris/actions-gh-pages uses: peaceiris/actions-gh-pages@v3 with: # GTIHUB_TOKEN：https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token # Github 会在 workflow 中自动生成 GIHUBT_TOKEN，用于认证 workflow 的运行 github_token: ${{ secrets.GITHUB_TOKEN }} # 静态资源目录设置 publish_dir: ./docs/.vuepress/dist # 默认发布到 gh-pages 分支上，可以指定特定的发布分支 publish_branch: gh-pages1 # default: gh-pages full_commit_message: ${{ github.event.head_commit.message }} # # timeout-minutes: 一个 job 执行的最大时间，默认是 6h，如果超过时间则取消执行 # # strategy.matrix: 例如指定当前 job 的 node 版本列表、操作系统类型列表等 # strategy.fail-fast # strategy.max-parallel # continue-on-error: 一旦当前 job 执行失败，那么 workflow 停止执行。设置为 true 可以跳过当前 job 执行 # container: Docker 容器配置，包括 image、env、ports、volumes、options 等配置 # # services: 使用 Docker 容器 Action 或者 服务 Action 必须使用 Linux 环境运行