Clarify ciBuild, forceProductionBuild, and package.json workflow in the Vaadin Docs
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
ciBuild、forceProductionBuild、default bundles、package.json/package-lock.json を使ったワークフローについて説明している Vaadin Docs のページと例を見つけてください。まず、それらの説明を報告された npm ci の失敗と比較します。ciBuild が必要または不要な場合をドキュメントで明確に示し、forceProductionBuild とそのトレードオフを説明し、lockfile と npm バージョンに関する警告を扱えていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Problem
Documentation doesn't clearly explain the corelation between ciBuild, forceProductionBuild, package.json/package-lock.json, and when to use which approach.
Common misconception causing build failures
Issue observed:
Users configure production profile with ciBuild=true by default (as shown in various examples),
but this causes builds to fail on CI for simple projects that use default bundles.
Error message:
npm error `npm ci` can only install packages when your package.json and package-lock.json...
Root cause:
- Simple projects (no @NpmPackage, no 3rd-party components) use default bundles
- Default bundles don't generate package.json/package-lock.json
- Production profile examples often include
ciBuild=true - This causes
npm cito fail because required json files don't exist
What users need to understand:
ciBuild=true is not a universal production setting - it's only needed when you have custom npm dependencies.
Key clarifications needed:
When to use ciBuild
- when package.json and package-lock.json are committed to repository
- Trade off: Developer must run frontend build WITHOUT ciBuild locally first, then commit the updated json files
When NOT to use ciBuild
- When using default bundles (json files aren't even generated in this case)
- Don't include package.json/package-lock.json in repository if build uses default bundles
About forceProductionBuild
- it is a workaround for when automatic detection fails
- potentially need to update package-lock.json with ciBuild
- makes builds always slow, but ensures robust builds
- Not recommended as default: Only for catching issues early or working around detection problems
Important warnings
- If CI runs
npm installwithout package-lock.json → vulnerable to npm malware and random problems - Different npm versions (from different Node.js versions) can cause slightly different package-lock.json files
- This can lead to merge conflicts even when dependencies haven't changed
- 主要言語
- AsciiDoc
- スター
- 38
- フォーク
- 225
- 平均マージ
- 17時間 38分
- マージ済み PR(30日)
- 214
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
vaadin/docs のほかの issue
-
Creating Tests page uses deprecated TestBench ElementQuery API対応中かも @jcgueriaud1 が 5 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信
-
design system
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
vaadin/docs#5773 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
design system
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
a11y design system
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
a11y design system
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
Feyisara2108/stellargive#1374 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
sno-ai/sno-station#228 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
tauri-apps/tauri#16563 ·
メンテナーはふだん 1 日以内に返信