@kevisual/cnb 0.0.40 → 0.0.43

package/src/issue/npc/pr-env.ts

@@ -0,0 +1,95 @@
+import { useKey } from "@kevisual/context";
+
+// CNB_PULL_REQUEST	false	对于由 pull_request、pull_request.update、pull_request.target 触发的构建，值为 true，否则为 false
+// CNB_PULL_REQUEST_LIKE	false	对于由 合并类事件 触发的构建，值为 true，否则为 false
+// CNB_PULL_REQUEST_PROPOSER		对于由 合并类事件 触发的构建，值为提出 PR 者名称，否则为空字符串
+// CNB_PULL_REQUEST_TITLE		对于由 合并类事件 触发的构建，值为提 PR 时候填写的标题，否则为空字符串
+// CNB_PULL_REQUEST_BRANCH		对于由 合并类事件 触发的构建，值为发起 PR 的源分支名称，否则为空字符串
+// CNB_PULL_REQUEST_SHA		对于由 合并类事件 触发的构建，值为当前 PR 源分支最新的提交 sha，否则为空字符串
+// CNB_PULL_REQUEST_TARGET_SHA		对于由 合并类事件 触发的构建，值为当前 PR 目标分支最新的提交 sha，否则为空字符串
+// CNB_PULL_REQUEST_MERGE_SHA		对于由 pull_request.merged 触发的构建，值为合并后的 sha；对于 pull_request 等触发的构建，值为预合并后的 sha，否则为空字符串
+// CNB_PULL_REQUEST_SLUG		对于由 合并类事件 触发的构建，值为源仓库的仓库 slug，如 group_slug/repo_name，否则为空字符串
+// CNB_PULL_REQUEST_ACTION		对于由 合并类事件 触发的构建，可能的值有：created(新建PR)、code_update(源分支push)、status_update(评审通过或CI状态变更)，否则为空字符串
+// CNB_PULL_REQUEST_ID		对于由 合并类事件 触发的构建，值为当前或者关联 PR 的全局唯一 id，否则为空字符串
+export const usePullRequestEnv = () => {
+  const pullRequest = useKey("CNB_PULL_REQUEST");
+  const pullRequestLike = useKey("CNB_PULL_REQUEST_LIKE");
+  const pullRequestProposer = useKey("CNB_PULL_REQUEST_PROPOSER");
+  const pullRequestTitle = useKey("CNB_PULL_REQUEST_TITLE");
+  const pullRequestBranch = useKey("CNB_PULL_REQUEST_BRANCH");
+  const pullRequestSha = useKey("CNB_PULL_REQUEST_SHA");
+  const pullRequestTargetSha = useKey("CNB_PULL_REQUEST_TARGET_SHA");
+  const pullRequestMergeSha = useKey("CNB_PULL_REQUEST_MERGE_SHA");
+  const pullRequestSlug = useKey("CNB_PULL_REQUEST_SLUG");
+  const pullRequestAction = useKey("CNB_PULL_REQUEST_ACTION");
+  const pullRequestId = useKey("CNB_PULL_REQUEST_ID");
+
+  return {
+    /**
+     * @key CNB_PULL_REQUEST
+     * @description:对于由 pull_request、pull_request.update、pull_request.target 触发的构建，值为 true，否则为 false
+     */
+    pullRequest,
+    pullRequestLabel: "对于由 pull_request、pull_request.update、pull_request.target 触发的构建，值为 true，否则为 false",
+    /**
+     * @key CNB_PULL_REQUEST_LIKE
+     * @description:对于由 合并类事件 触发的构建，值为 true，否则为 false
+     */
+    pullRequestLike,
+    pullRequestLikeLabel: "对于由 合并类事件 触发的构建，值为 true，否则为 false",
+    /**
+     * @key CNB_PULL_REQUEST_PROPOSER
+     * @description:对于由 合并类事件 触发的构建，值为提出 PR 者名称，否则为空字符串
+     */
+    pullRequestProposer,
+    pullRequestProposerLabel: "对于由 合并类事件 触发的构建，值为提出 PR 者名称，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_TITLE
+     * @description:对于由 合并类事件 触发的构建，值为提 PR 时候填写的标题，否则为空字符串
+     */
+    pullRequestTitle,
+    pullRequestTitleLabel: "对于由 合并类事件 触发的构建，值为提 PR 时候填写的标题，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_BRANCH
+     * @description:对于由 合并类事件 触发的构建，值为发起 PR 的源分支名称，否则为空字符串
+     */
+    pullRequestBranch,
+    pullRequestBranchLabel: "对于由 合并类事件 触发的构建，值为发起 PR 的源分支名称，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_SHA
+     * @description:对于由 合并类事件 触发的构建，值为当前 PR 源分支最新的提交 sha，否则为空字符串
+     */
+    pullRequestSha,
+    pullRequestShaLabel: "对于由 合并类事件 触发的构建，值为当前 PR 源分支最新的提交 sha，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_TARGET_SHA
+     * @description:对于由 合并类事件 触发的构建，值为当前 PR 目标分支最新的提交 sha，否则为空字符串
+     */
+    pullRequestTargetSha,
+    pullRequestTargetShaLabel: "对于由 合并类事件 触发的构建，值为当前 PR 目标分支最新的提交 sha，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_MERGE_SHA
+     * @description:对于由 pull_request.merged 触发的构建，值为合并后的 sha；对于 pull_request 等触发的构建，值为预合并后的 sha，否则为空字符串
+     */
+    pullRequestMergeSha,
+    pullRequestMergeShaLabel: "对于由 pull_request.merged 触发的构建，值为合并后的 sha；对于 pull_request 等触发的构建，值为预合并后的 sha，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_SLUG
+     * @description:对于由 合并类事件 触发的构建，值为源仓库的仓库 slug，如 group_slug/repo_name，否则为空字符串
+     */
+    pullRequestSlug,
+    pullRequestSlugLabel: "对于由 合并类事件 触发的构建，值为源仓库的仓库 slug，如 group_slug/repo_name，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_ACTION
+     * @description:对于由 合并类事件 触发的构建，可能的值有：created(新建PR)、code_update(源分支push)、status_update(评审通过或CI状态变更)，否则为空字符串
+     */
+    pullRequestAction,
+    pullRequestActionLabel: "对于由 合并类事件 触发的构建，可能的值有：created(新建PR)、code_update(源分支push)、status_update(评审通过或CI状态变更)，否则为空字符串",
+    /**
+     * @key CNB_PULL_REQUEST_ID
+     * @description:对于由 合并类事件 触发的构建，值为当前或者关联 PR 的全局唯一 id，否则为空字符串
+     */
+    pullRequestId,
+    pullRequestIdLabel: "对于由 合并类事件 触发的构建，值为当前或者关联 PR 的全局唯一 id，否则为空字符串"
+  };
+}

package/src/issue/npc/repo-env.ts

@@ -0,0 +1,56 @@
+import { useKey } from "@kevisual/context";
+
+// CNB_REPO_SLUG	kevision/dev-cnb	目标仓库路径，格式为 group_slug / repo_name，group_slug / sub_gourp_slug /.../repo_name
+// CNB_REPO_SLUG_LOWERCASE	kevision/dev-cnb	目标仓库路径小写格式
+// CNB_REPO_NAME	dev-cnb	目标仓库名称
+// CNB_REPO_NAME_LOWERCASE	dev-cnb	目标仓库名称小写格式
+// CNB_REPO_ID	2026263219584110592	目标仓库的 id
+// CNB_REPO_URL_HTTPS		目标仓库 https 地址
+export const useRepoInfoEnv = () => {
+  const repoSlug = useKey("CNB_REPO_SLUG");
+  const repoSlugLowercase = useKey("CNB_REPO_SLUG_LOWERCASE");
+  const repoName = useKey("CNB_REPO_NAME");
+  const repoNameLowercase = useKey("CNB_REPO_NAME_LOWERCASE");
+  const repoId = useKey("CNB_REPO_ID");
+  const repoUrlHttps = useKey("CNB_REPO_URL_HTTPS");
+
+  return {
+    /**
+     * @key CNB_REPO_SLUG
+     * @description:目标仓库路径，格式为 group_slug/repo_name，group_slug/sub_group_slug/.../repo_name
+     */
+    repoSlug,
+    repoSlugLabel: "目标仓库路径，格式为 group_slug/repo_name，group_slug/sub_group_slug/.../repo_name",
+    /**
+     * @key CNB_REPO_SLUG_LOWERCASE
+     * @description:目标仓库路径小写格式
+     */
+    repoSlugLowercase,
+    repoSlugLowercaseLabel: "目标仓库路径小写格式",
+    /**
+     * @key CNB_REPO_NAME
+     * @description:目标仓库名称
+     */
+    repoName,
+    repoNameLabel: "目标仓库名称",
+    /**
+     * @key CNB_REPO_NAME_LOWERCASE
+     * @description:目标仓库名称小写格式
+     */
+    repoNameLowercase,
+    repoNameLowercaseLabel: "目标仓库名称小写格式",
+    /**
+     * @key CNB_REPO_ID
+     * @description:目标仓库的 id
+     */
+    repoId,
+    repoIdLabel: "目标仓库的 id",
+    /**
+     * @key CNB_REPO_URL_HTTPS
+     * @description:目标仓库 https 地址
+     */
+    repoUrlHttps,
+    repoUrlHttpsLabel: "目标仓库 https 地址"
+  };
+}
+