Skip to content

Commit 6b4d9b6

Browse files
committed
Add bilingual docs summaries and main push deploy guard
1 parent 17c72d5 commit 6b4d9b6

4 files changed

Lines changed: 31 additions & 0 deletions

File tree

.github/workflows/sync-cloud-run-env.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
env:
2525
ENABLE_GITHUB_CLOUD_RUN_DEPLOY: ${{ vars.ENABLE_GITHUB_CLOUD_RUN_DEPLOY }}
2626
ENABLE_GITHUB_ENV_SYNC: ${{ vars.ENABLE_GITHUB_ENV_SYNC }}
27+
ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION: ${{ vars.ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION }}
2728
CLOUD_RUN_REGION: ${{ vars.CLOUD_RUN_REGION }}
2829
CLOUD_RUN_SERVICE: ${{ vars.CLOUD_RUN_SERVICE }}
2930
TELEGRAM_TOKEN_SECRET_NAME: ${{ vars.TELEGRAM_TOKEN_SECRET_NAME }}
@@ -118,6 +119,12 @@ jobs:
118119
run: |
119120
set -euo pipefail
120121
122+
if [ "${GITHUB_EVENT_NAME:-}" = "push" ] && [ "${ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION:-}" != "true" ]; then
123+
echo "enabled=false" >> "$GITHUB_OUTPUT"
124+
echo "Skipping Cloud Run deploy on push because ENABLE_MAIN_PUSH_CLOUD_RUN_AUTOMATION is not true." >&2
125+
exit 0
126+
fi
127+
121128
if [ "${ENABLE_GITHUB_CLOUD_RUN_DEPLOY:-true}" != "true" ]; then
122129
echo "enabled=false" >> "$GITHUB_OUTPUT"
123130
echo "Skipping Cloud Run deploy because ENABLE_GITHUB_CLOUD_RUN_DEPLOY is not true." >&2

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Contributing
22

3+
4+
## 中文摘要
5+
6+
- 用途:本文档围绕 `Contributing`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖:`Contributing`
8+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
311
Keep this repository conservative. Firstrade support is based on an unofficial
412
reverse-engineered package, so changes should preserve local safety controls and
513
make failure modes obvious.

NOTICE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Notices
22

3+
4+
## 中文摘要
5+
6+
- 用途:本文档围绕 `Notices`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖:`Notices`
8+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
311
This repository integrates with the third-party `firstrade` Python package:
412

513
- Project: https://github.com/MaxxRK/firstrade-api

SECURITY.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Security Policy
22

3+
4+
## 中文摘要
5+
6+
- 用途:本文档围绕 `Security Policy`,用于理解 `FirstradePlatform` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖:`Security Policy`
8+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
311
This repository integrates with an unofficial, reverse-engineered Firstrade API
412
client. Treat credentials, cookies, MFA secrets, and debug logs as highly
513
sensitive.

0 commit comments

Comments
 (0)