From 6b4d9b66975fd5644dce06a3a98ff4716f9a7750 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Mon, 1 Jun 2026 03:47:05 +0800 Subject: [PATCH] Add bilingual docs summaries and main push deploy guard --- .github/workflows/sync-cloud-run-env.yml | 7 +++++++ CONTRIBUTING.md | 8 ++++++++ NOTICE.md | 8 ++++++++ SECURITY.md | 8 ++++++++ 4 files changed, 31 insertions(+) diff --git a/.github/workflows/sync-cloud-run-env.yml b/.github/workflows/sync-cloud-run-env.yml index 2f745a3..717ab78 100644 --- a/.github/workflows/sync-cloud-run-env.yml +++ b/.github/workflows/sync-cloud-run-env.yml @@ -24,6 +24,7 @@ jobs: env: ENABLE_GITHUB_CLOUD_RUN_DEPLOY: ${{ vars.ENABLE_GITHUB_CLOUD_RUN_DEPLOY }} ENABLE_GITHUB_ENV_SYNC: ${{ vars.ENABLE_GITHUB_ENV_SYNC }} + ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION: ${{ vars.ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION }} CLOUD_RUN_REGION: ${{ vars.CLOUD_RUN_REGION }} CLOUD_RUN_SERVICE: ${{ vars.CLOUD_RUN_SERVICE }} TELEGRAM_TOKEN_SECRET_NAME: ${{ vars.TELEGRAM_TOKEN_SECRET_NAME }} @@ -118,6 +119,12 @@ jobs: run: | set -euo pipefail + if [ "${GITHUB_EVENT_NAME:-}" = "push" ] && [ "${ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION:-}" != "true" ]; then + echo "enabled=false" >> "$GITHUB_OUTPUT" + echo "Skipping Cloud Run deploy on push because ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION is not true." >&2 + exit 0 + fi + if [ "${ENABLE_GITHUB_CLOUD_RUN_DEPLOY:-true}" != "true" ]; then echo "enabled=false" >> "$GITHUB_OUTPUT" echo "Skipping Cloud Run deploy because ENABLE_GITHUB_CLOUD_RUN_DEPLOY is not true." >&2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a10a7b..1ab1190 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,13 @@ # Contributing + +## 中文摘要 + +- 用途:本文档围绕 `Contributing`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Contributing`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 Keep this repository conservative. Firstrade support is based on an unofficial reverse-engineered package, so changes should preserve local safety controls and make failure modes obvious. diff --git a/NOTICE.md b/NOTICE.md index c88b085..b82a06e 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -1,5 +1,13 @@ # Notices + +## 中文摘要 + +- 用途:本文档围绕 `Notices`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Notices`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 This repository integrates with the third-party `firstrade` Python package: - Project: https://github.com/MaxxRK/firstrade-api diff --git a/SECURITY.md b/SECURITY.md index 324822a..ffec1ce 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,13 @@ # Security Policy + +## 中文摘要 + +- 用途:本文档围绕 `Security Policy`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Security Policy`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 This repository integrates with an unofficial, reverse-engineered Firstrade API client. Treat credentials, cookies, MFA secrets, and debug logs as highly sensitive.