{"id":48861763,"url":"https://github.com/crper/jk2dt","last_synced_at":"2026-04-15T16:31:08.453Z","repository":{"id":57281016,"uuid":"228374560","full_name":"crper/jk2dt","owner":"crper","description":"Jenkins 构建概要信息推送钉钉群(结合 Gitlab)","archived":false,"fork":false,"pushed_at":"2019-12-16T12:26:04.000Z","size":454,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-28T06:36:27.651Z","etag":null,"topics":["dingtalk","dingtalk-robot","gitlab-ci","jenkins"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crper.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-16T11:43:34.000Z","updated_at":"2024-04-18T13:08:07.000Z","dependencies_parsed_at":"2022-09-06T01:02:28.341Z","dependency_job_id":null,"html_url":"https://github.com/crper/jk2dt","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/crper/jk2dt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crper%2Fjk2dt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crper%2Fjk2dt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crper%2Fjk2dt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crper%2Fjk2dt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crper","download_url":"https://codeload.github.com/crper/jk2dt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crper%2Fjk2dt/sbom","scorecard":{"id":309796,"data":{"date":"2025-08-11","repo":{"name":"github.com/crper/jk2dt","commit":"4d362dcb8b392d97b09bbbf811c547e155c43a9d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/2 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T22:57:09.886Z","repository_id":57281016,"created_at":"2025-08-17T22:57:09.886Z","updated_at":"2025-08-17T22:57:09.886Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31849682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dingtalk","dingtalk-robot","gitlab-ci","jenkins"],"created_at":"2026-04-15T16:31:07.511Z","updated_at":"2026-04-15T16:31:08.448Z","avatar_url":"https://github.com/crper.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#### 结合 Gitlab 和钉钉的自定义机器人(webhook 触发)的一个推送封装\n\n\n\n## 效果图\n\n- **打包的版本号仅在 master 和 dev 才有可能出现，对应 npm 的 dist-tags 的 latest 和 dev**\n\n- **banner 不传是没有顶部的图片的,也支持文本的传入或者标准的 markdown 字符串**\n\n### 稳定版\n\n![](./assets/card_jk2dt_latest.png)\n\n### 开发版\n\n![](./assets/card_jk2dt_dev.png)\n\n## 安装\n\n```bash\nnpm i -D jk2dt\n```\n\n## 使用\n\n### 配置文件\n\n1. 在根目录提供`jk2dtrc.js`,格式为\n\n```javascript\nmodule.exports = {\n  git: {\n    RepoTitle: \"测试标题\"\n  }\n};\n```\n\n2. 在`package.json`内添加执行的 scripts\n\n```json\n{\n  \"scripts\": {\n    \"jk2dt\": \"jk2dt\"\n  }\n}\n```\n\n### package.json\n\n提供`jk2dt`键值对\n\n```json\n{\n  \"scripts\": {\n    \"jk2dt\": \"jk2dt\"\n  },\n  \"jk2dt\": { \"git\": { \"RepoTitle\": \"呵呵哒\" } }\n}\n```\n\n**两者都提供的情况下优先读取配置文件的**\n\n\n\n### 模块引用\n\n```javascript\nconst jk2dt = require('@h3/jenkins-2-dingtalk);\n\n// 若是只有一个群，只要传入符合dingtalk 的 postdata 数据即可\n// 若是有多个，对象可以加到数组里面，传入数组\njk2dt(params);\n```\n\n\n\n\n\n\n\n## 可配置的\n\n可以更改部分 git 的信息，亦或者推送的格式，更多的定制可以查看源码传入。\n\n很多是关联性配置，所以只要传入最小化的核心参数即可。\n\n```javascript\nconfig:{\n  git:{}, // git的一些配置\n  banner:'', // 消息卡片的 banner\n  push:{} // 钉钉的推送 data，这个可以覆盖整个推送的钉钉数据，包括 ak,at ，乃至不要卡片化\n  ak:{}, // 钉群的 accessToken\n  at:{}, // 全局钉钉@谁或者全体\n}\n// 权重 push-\u003e at、ak\n```\n\n### Git\n\n| 参数                | 说明                                           | 类型          | 默认值 |\n| ------------------- | ---------------------------------------------- | ------------- | ------ |\n| RepoDoc             | 文档的链接                                     | string?(可选) | ''     |\n| RepoDomain          | gitlab 的域名,不传则默认从jenkins 环境变量拿整个仓库的 url | string        | ''     |\n| RepoGroup           | 参数所属 Gitlab 的群组                         | string        | ''     |\n| RepoTitle           | 仓库的中文名,不传则拿仓库名字                  | string        | ''     |\n| RepoCommitCountShow | 显示最近几次 commit                            | Number        | 5      |\n| RepoIssues          | issue 的链接，没有则内部构建拼接              | string        | ''     |\n| RepoChangelog       | changelog 的链接，没有则内部构建拼接          | string        | ''     |\n| JOB_DOMAIN       | Jenkins Job 的链接           | string        | ''  |\n\n其他分支这些的信息是从 jenkins 上拿取的，没有特殊情况不需要去调整\n\n### Banner\n\n支持 markdown 的传入,用字符串包裹,亦或者纯文本\n\n```bash\n![](https://xxxxx.png)\\n\n```\n\n\n\n### AccessToken(ak)\n\n这个本来是属于钉钉推送的里面的，抽离出来可单独配置,对应上面的`ak`参数，`ak`可以结合分支。\n\n- 成功的情况下 master 丢大群，其他对应分支群（无对应 token 则走 dev ）\n- 失败的情况下，优先找是否有配置 error 的 ak，没有走 dev\n\n```mermaid\ngraph TD\nJenkins[Jenkins构建] --\u003e success(成功)\nJenkins[Jenkins构建] --\u003e fail(失败)\nsuccess --\u003e  isAKStr{ak分支值为字符串?}\nisAKStr --\u003e 推送\nsuccess --\u003e  isAKObj{ak分支值为对象?}\nisAKObj --\u003e 遍历数组分别推送不同的群\nfail --\u003e isAKErr{ak配置了error? }\nisAKErr --\u003e isTrue[是]\nisTrue --\u003e 推送ak为error的群\nisAKErr --\u003e isFalse[否]\nisFalse --\u003e 推送ak为dev的群\n```\n\n| 值   | 介绍                | 类型          | 默认值 |\n| ---- | ------------------- | ------------- | ------ |\n| 分支 | 就是 git 的分支名字 | String/Object | ''     | v |\n\n#### 常规字符串键值对\n\n```javsacript\n{\n  master: 'xxxx', // 稳定版成功发布推送的群(必须)\n  dev: 'xxxx', // 不管成功失败都丢的群(必须)\n  next:'xxx', // 若是有超前版本也可以单独推送到内测群组,不设置则默认走 dev\n  test:'xxx', // 若是配置可以推送给测试群，不设置则默认走 dev\n  error:'xxx', // 失败优先推送的群组，没有走 dev\n};\n```\n\n**匹配不到的分支优先寻找 error 的 ak，没有默认走 dev 的 ak**\n\n#### 数组对象格式\n\n**此处做了强校验，对象传入必须两个数组存在且不为空，否则忽略该东东**\n\n**键值对字符串依旧遵循上面的规则**\n\n```javsacript\n{\n  master:{\n    success:[], // 成功推向的哪些群\n    error:[], // 失败推向的哪几个群\n  },\n};\n```\n\n### at(通知)\n\n这也是属于钉钉构建数据的一部分，这里单独抽离也是支持某些分支是否要@全体，或者某人\n\n#### 格式\n\n```js\nak: {\n  master: {\n    \"atMobiles\": [\n        \"156xxxx8827\",\n        \"189xxxx8325\"\n    ],\n    \"isAtAll\": false\n  }\n}\n```\n\n**若是不传则走默认逻辑,只有 master 构建成功的时侯才去@全体**\n\n#### 钉钉的推送格式\n\n详情请看：[钉钉自定义机器人文档](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq)。\n\n此处封装用的是 markdown 风格,推送的 json 如下\n\n```bash\n{\n  accessToken: 'xxxx5',\n  postData: {\n    msgtype: 'markdown',\n    markdown: {\n      title: '构建 undefined(undefined 构建过程日志)',\n      text: '![](https://hxxxxxsome-UI.jpg)\\n' +\n        '\\n' +\n        '\\n' +\n        '  \u003e PC端UI组件库(h3-ui/undefined)\\n' +\n        '  \u003e\\n' +\n        '  \u003e [docs](http://h3uxxyun.com/pcdoc/) |  [repo](http://gitxxn.com/h3-ui/undefined) | [issues](http://gitlxxn.com/h3-ui/undefined/issues) | [changelog](http://gitlaxx.com/h3-ui/undefined/blob/master/CHANGELOG.md)\\n' +\n        '\\n' +\n        '### --- undefined ---\\n' +\n        '\\n' +\n        '\\n' +\n        '**构建分支:** [origin/undefined](http://gitlxx.com/h3-ui/undefined/commits/undefined)\\n' +\n        '\\n' +\n        '### --- Jenkins ---\\n' +\n        '\\n' +\n        '**代码推送:** undefined(undefined)\\n' +\n        '\\n' +\n        '**构建任务:** undefined\\n' +\n        '\\n' +\n        '**构建日志:** [undefined 构建过程日志](https://xxxxx/jenkins/job/undefined/undefined/console)\\n' +\n        '\\n' +\n        '**构建状态:构建失败**\\n' +\n        '\\n' +\n        '**构建时间:2019-12-16 17:04**\\n'\n    },\n    at: { isAtAll: false }\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrper%2Fjk2dt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrper%2Fjk2dt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrper%2Fjk2dt/lists"}