everkm-publish 0.16.15 → 0.17.1

package/.github/workflows/publish-npm.yaml

@@ -0,0 +1,154 @@
+name: Publish NPM Package
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Semver，如 0.16.15"
+        required: true
+        type: string
+      skip_npm:
+        description: "仅上传 CDN，不 npm publish"
+        type: boolean
+        default: false
+      force_cdn:
+        description: "强制重传 CDN（忽略已存在）"
+        type: boolean
+        default: false
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    outputs:
+      run_started_at: ${{ steps.record-start.outputs.run_started_at }}
+      skipped: ${{ steps.publish-run.outputs.skipped }}
+      version: ${{ steps.publish-run.outputs.version }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - id: record-start
+        run: echo "run_started_at=$(date -u +%Y-%m-%dT%H:%M:%SZ)" >> "$GITHUB_OUTPUT"
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
+      - name: Setup qshell
+        uses: foxundermoon/setup-qshell@v5
+        with:
+          version: "2.16.0"
+
+      - id: ver
+        name: Resolve version
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "version=${{ inputs.version }}" >> "$GITHUB_OUTPUT"
+          else
+            echo "version=${GITHUB_REF#refs/tags/v}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - id: publish-run
+        name: Mirror everkm/publish Release to CDN
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          CF_S3_AK: ${{ secrets.CF_S3_AK }}
+          CF_S3_SK: ${{ secrets.CF_S3_SK }}
+          QINIU_ACCESS_KEY: ${{ secrets.QINIU_ACCESS_KEY }}
+          QINIU_SECRET_KEY: ${{ secrets.QINIU_SECRET_KEY }}
+        run: |
+          args=(--version "${{ steps.ver.outputs.version }}")
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ] && [ "${{ inputs.force_cdn }}" = "true" ]; then
+            args+=(--force-cdn)
+          fi
+          python scripts/publish-npm-package.py "${args[@]}"
+          code=$?
+          echo "version=${{ steps.ver.outputs.version }}" >> "$GITHUB_OUTPUT"
+          if [ "$code" -eq 2 ]; then
+            echo "skipped=true" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+          exit "$code"
+
+      - name: Setup Node
+        if: steps.publish-run.outputs.skipped != 'true'
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          registry-url: https://registry.npmjs.org
+
+      - name: Bump package.json version
+        if: steps.publish-run.outputs.skipped != 'true'
+        run: npm version "${{ steps.ver.outputs.version }}" --no-git-tag-version
+
+      - name: Publish to npm
+        if: |
+          steps.publish-run.outputs.skipped != 'true' &&
+          (github.event_name != 'workflow_dispatch' || inputs.skip_npm != true)
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public
+
+  notify:
+    runs-on: ubuntu-latest
+    needs: [publish]
+    if: always()
+    steps:
+      - name: Notify workflow run
+        env:
+          NOTIFY_DAYU_ENDPOINT: ${{ secrets.NOTIFY_DAYU_ENDPOINT }}
+          PUBLISH_RESULT: ${{ needs.publish.result }}
+          PUBLISH_SKIPPED: ${{ needs.publish.outputs.skipped }}
+          PUBLISH_VERSION: ${{ needs.publish.outputs.version }}
+          PUBLISH_TRIGGER: ${{ github.event_name }}
+          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          RUN_STARTED_AT: ${{ needs.publish.outputs.run_started_at }}
+          PYTHONIOENCODING: utf-8
+        run: |
+          if [ -z "$NOTIFY_DAYU_ENDPOINT" ]; then
+            echo "NOTIFY_DAYU_ENDPOINT secret not set, skip notify"
+            exit 0
+          fi
+          NOTIFY_URL="${NOTIFY_DAYU_ENDPOINT%/}/api/notify/tg"
+          python3 <<'PY' > /tmp/notify-payload.json
+          import json, os
+          from datetime import datetime, timezone
+
+          started_at = os.environ.get("RUN_STARTED_AT", "").strip()
+          if started_at:
+              start = datetime.fromisoformat(started_at.replace("Z", "+00:00"))
+              duration = "%.1f 分钟" % (
+                  (datetime.now(timezone.utc) - start).total_seconds() / 60)
+          else:
+              duration = "未知"
+
+          ver = os.environ.get("PUBLISH_VERSION") or "未知"
+          trigger = os.environ.get("PUBLISH_TRIGGER", "")
+          result = os.environ["PUBLISH_RESULT"]
+          if os.environ.get("PUBLISH_SKIPPED") == "true":
+              result = "skipped（npm 与 CDN 均已就绪）"
+
+          b = (
+              "everkm-publish npm 发布工作流已完成。\n"
+              "总耗时：%s。\n"
+              "触发：%s\n"
+              "版本：%s\n"
+              "结果：%s\n"
+              "Action：%s"
+          ) % (duration, trigger, ver, result, os.environ["RUN_URL"])
+          print(json.dumps({
+              "subject": "everkm-publish-npm Publish（%s）" % result,
+              "body": b,
+          }, ensure_ascii=False))
+          PY
+          curl --location "$NOTIFY_URL" \
+            -H 'Content-Type: application/json' \
+            --data-binary @/tmp/notify-payload.json

package/Makefile

@@ -0,0 +1,6 @@
+.PHONY: tag
+tag:
+	@if [ "$(TAG)" != "" ]; then \
+		git tag -f $(TAG); \
+		git push -f github $(TAG); \
+	fi

package/README-MAINTAINERS.md

@@ -0,0 +1,61 @@
+# Maintainers
+
+本仓库即 [`everkm/publish`](https://github.com/everkm/publish)（`everkm-publish-npm` 仅为本地/历史别名）。
+
+## Release
+
+1. **Binary Release** — tag 触发构建并发布 GitHub Release（含 notes）:
+
+   ```bash
+   git tag everkm-publish@v0.17.0
+   git push origin everkm-publish@v0.17.0
+   ```
+
+   等待构建完成，确认 Release 资产与 notes。
+
+2. **CDN + npm** — semver tag 触发 CDN 镜像与 npm publish:
+
+   ```bash
+   git tag v0.17.0
+   git push origin v0.17.0
+
+   # or via Makefile
+   make tag TAG=v0.17.0
+   ```
+
+3. Verify:
+
+   ```bash
+   curl -s https://ekmp-assets.everkm.com/pkgs/latest.json
+   npm view everkm-publish version
+   ```
+
+Manual re-run: GitHub Actions → **Publish NPM Package** → `workflow_dispatch`.
+
+## GitHub Secrets
+
+| Secret | 用途 |
+|--------|------|
+| `CF_S3_AK` / `CF_S3_SK` | Cloudflare R2 上传 |
+| `QINIU_ACCESS_KEY` / `QINIU_SECRET_KEY` | 七牛上传与 CDN 刷新 |
+| `GH_TOKEN` | 读取同仓 GitHub Release（未设置时回退 `GITHUB_TOKEN`） |
+| `NPM_TOKEN` | npm publish（见下） |
+| `NOTIFY_DAYU_ENDPOINT` | workflow 结束 Telegram 通知（可选） |
+
+### `NPM_TOKEN` 配置
+
+CI 无法输入 authenticator 验证码；若账号启用了 2FA，token **必须**支持自动化发布，否则 `npm publish` 会报 `EOTP`。
+
+在 [npmjs.com](https://www.npmjs.com) → **Access Tokens** 创建 **Granular Access Token**（或 Classic **Automation** token）：
+
+1. **Packages and scopes**：对 `everkm-publish` 授予 **Read and write**（或 all packages）
+2. **Security settings**：勾选 **Bypass two-factor authentication (2FA)**
+3. 若包归属 npm organization，还需在 **Organizations** 中授权对应 org
+
+将 token 写入仓库 **Settings → Secrets → Actions → `NPM_TOKEN`**。更新后重新跑 workflow 即可。
+
+本地验证 token：
+
+```bash
+npm whoami --registry=https://registry.npmjs.org/ --//registry.npmjs.org/:_authToken=YOUR_TOKEN
+```

package/README.md

@@ -1,13 +1,19 @@
 ## Usage
 
-Static Content Generator. Pure
-HTML template engine base on markdown files, syntax from Jinja2. Built for
-official website, Blog and WIKI, and so on. 
-Please to visit [Everkm Publish](https://publish.everkm.com) for more details。
+Static Content Generator. Pure HTML template engine based on markdown files, syntax from Jinja2. Built for official website, Blog and WIKI, and so on.
 
-## 中国用户安装
+Please visit [Everkm Publish](https://publish.everkm.com) for more details.
+
+## Install
 
 ```bash
-EVERKM_PUBLISH_BINARY=https://assets.daobox.cc/everkm-publish/stable/ npm add everkm-publish
+npm add everkm-publish
+# or
+pnpm add everkm-publish
+```
+
+`postinstall` downloads the platform binary from CDN (`.com` → GitHub → `.cn`), with a 5s timeout per source.
+
+---
 
-```
+Maintainers: see [README-MAINTAINERS.md](./README-MAINTAINERS.md).