Build secrets docs lie?

オープン
  • 何か問題がありますか？
#2,026 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
docker, github-actions, html
領域
cloud, devops, documentation

調査の方向性

影響を受ける build-secrets のドキュメントページから始め、runtime-secrets の説明を fly deploy --build-secret の例と比較します。GitHub Actions での --remote-only シナリオを含め、アプリケーションの secrets と build secrets がどのように関係するかを確認し、その後、必要な secret のソースと想定されるワークフローが明確になるように説明と例を更新します。

索引モデルが issue の本文から書いたものです。

説明

Link to the affected page or pages
(https://fly.io/docs/apps/build-secrets/

Describe what parts of the doc need improvement
You say "You can set secrets for your applications, but these are only available at run-time. They aren’t available when building your Docker image without a little extra work."

Ok. So I expect that I can use app secrets in build stage.
Then why in step 2 you say that some value should be provided? It's already in app secret (I just added it through UI in section "Secrets" of my application) and I expect that I can just use it with "a little extra work".

fly deploy \
    --build-secret MY_SUPER_SECRET=some_value

From this docs I don't understand how to use my application secrets in build stage.
I use GitHub actions like:

    steps:
      - uses: actions/checkout@v4
      - uses: superfly/flyctl-actions/setup-flyctl@master
      - run: flyctl deploy --remote-only -c fly.production.toml
        env:
          FLY_API_TOKEN: ${{ secrets.FLY_PROD_APP_TOKEN }}

So I need to duplicate secret in GitHub to pass its value to command flyctl deploy and can't just use it?
Like the following?

    steps:
      - uses: actions/checkout@v4
      - uses: superfly/flyctl-actions/setup-flyctl@master
      - run: flyctl deploy --remote-only -c fly.production.toml --build-secret MY_SUPER_SECRET=${{ secrets.FLY_PROD_APP_TOKEN }}
        env:
          FLY_API_TOKEN: ${{ secrets.FLY_PROD_APP_TOKEN }}
主要言語
MDX
スター
128
フォーク
1.1k
平均マージ
20時間 58分
マージ済み PR（30日）
75

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

superfly/docs のほかの issue

superfly/docs の issue をすべて見る

似ている issue

Cloud の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。