Add more instructions for applying ORM migrations for S3 deployment
メンテナーはふだん 2 日以内に返信
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 68/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- aws, python
- 領域
- cloud, database, documentation
調査の方向性
初回セットアップの参照として提供されたユーザースクリプトを使用して、burr/tracking/server/s3/README.md を更新します。マイグレーションディレクトリの作成、burr.tracking.server.s3.settings.TORTOISE_ORM を指定した aerich init の実行、aerich init-db の実行、その後の S3 バックエンドでの Burr の起動をドキュメント化します。README が初期データベースの完全なセットアップを説明していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
The README does not contain the steps to properly set up the DB the first time.
Describe the solution you'd like
We should mention what to do -- we can use the script below for those instructions.
Describe alternatives you've considered
N/A
Additional context
User script that works:
#!/bin/sh
# Echo commands for debugging
set -x
# Signal handling:
trap 'echo "Caught signal, continuing anyway"' INT TERM
echo "Starting script execution"
# Create the directory structure if it doesn't exist
mkdir -p /root/.burr_server
echo "Created directory structure at /root/.burr_server"
# Initialize and apply migrations in the correct path
cd /app
echo "Running aerich init..."
aerich init -t burr.tracking.server.s3.settings.TORTOISE_ORM --location /root/.burr_server/migrations || echo "Aerich init failed or already initialized"
# Run aerich init-db with a timeout to prevent hanging
echo "Running aerich init-db..."
# Use timeout command to ensure we don't hang indefinitely
# aerich init-db will not exit or allow this script to continue without a timeout
timeout 10s aerich init-db > /tmp/aerich.log 2>&1 || echo "aerich init-db timed out or exited with non-zero status"
echo "aerich init-db result:"
cat /tmp/aerich.log
echo "Finished migration steps"
# Print database location information
echo "Database directory contents:"
ls -la /root/.burr_server/
echo "Database file exists check:"
test -f /root/.burr_server/db.sqlite3 && echo "Database file exists" || echo "Database file DOES NOT exist"
# Start the Burr server with verbose output
echo "Starting Burr server with --host 0.0.0.0 --backend s3"
burr --host 0.0.0.0 --backend s3
- 主要言語
- Python
- スター
- 2.6k
- フォーク
- 199
- 平均マージ
- 3日 10時間
- マージ済み PR(30日)
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/burr のほかの issue
-
status/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 2 日以内に返信
-
Streaming Event type, type hint, should support union type対応中かも @mvanhorn が 182 日前に担当しました。 オープンarea/streaming area/typing good first issue help wanted kind/bug priority/high
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 2 日以内に返信
-
Add documentation on how to run the Burr UI server再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンarea/ui good first issue kind/documentation priority/low
難易度 2/5 半日 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
status/needs-triage
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
-
status/needs-triage
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
changelog investigate
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ramnes/notion-sdk-py#409 ·
-
good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
lindicaphxag-tech/kaggle#28 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
BSData/horus-heresy-3rd-edition#3211 ·
メンテナーはふだん 1 日以内に返信
-
bug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
bug tests
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信