chore: 修改注释/发布脚本等

CaoMeiYouRen · Feb 27, 2021 · 51af58f · 51af58f
1 parent 071fb8b
commit 51af58f
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 40 deletions.
diff --git a/.env b/.env
diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml
diff --git a/.github/release.yml → .github/workflows/release.yml b/.github/release.yml → .github/workflows/release.yml
@@ -26,7 +26,7 @@ jobs:
       - run: yarn
       - run: npm run lint
       - run: npm run build
-    #   - env:
-    #       GH_TOKEN: ${{ secrets.GH_TOKEN }}
-    #       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    #     run: npm run release
+      - env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 CaoMeiYouRen(草梅友仁)
+Copyright (c) 2021 CaoMeiYouRen(草梅友仁)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/push/dingtalk.ts b/src/push/dingtalk.ts
@@ -9,10 +9,26 @@ import { Message } from './dingtalk/index'
 const Debugger = debug('push:dingtalk')
 
 class RobotOption {
+    /**
+     * 即 access_token
+     *
+     */
     accessToken?: string
+    /**
+     * 加签安全秘钥（HmacSHA256）
+     *
+     */
     secret?: string
 }
-
+/**
+ * 在 [dingtalk-robot-sdk](https://github.com/ineo6/dingtalk-robot-sdk) 的基础上重构了一下，用法几乎完全一致。
+ * 参考文档 [钉钉开放平台 - 自定义机器人接入](https://developers.dingtalk.com/document/app/custom-robot-access)
+ *
+ * @author CaoMeiYouRen
+ * @date 2021-02-27
+ * @export
+ * @class Dingtalk
+ */
 export class Dingtalk implements Send {
     private accessToken?: string
     private secret?: string
@@ -35,7 +51,14 @@ export class Dingtalk implements Send {
         }
         return signStr
     }
-
+    /**
+     *
+     *
+     * @author CaoMeiYouRen
+     * @date 2021-02-27
+     * @param message
+     * @returns
+     */
     public async send(message: Message): Promise<AxiosResponse<any>> {
         const timestamp = Date.now()
         const sign = this.getSign(timestamp)