digital form builder

XGov デジタル フォーム ビルダー

貢献

問題やプルリクエストは大歓迎です。まず CONTRIBUTING.md を確認してください。

このリポジトリは、

• @xgovformbuilder/runner - JSON ファイルからフォームを「実行」できる Hapi サーバー
• @xgovformbuilder/designer - フォーム構築を支援する React アプリ
• @xgovformbuilder/model - データ モデルとその他のヘルパーを提供します。
• @xgovformbuilder/e2e - エンドツーエンドのテスト

リポジトリは DEFRA のデジタル フォーム ビルダーからフォークされたものです。

これは、ゼロインストール (に近づいている) の Yarn 2 ワークスペース リポジトリです。 .yarnrc.yml を使用すると、糸環境を調整できます。 .yarn 内のプラグインはコミットしてください。ただし、.yarn/キャッシュはコミットしないでください。 CI はキャッシュを保存および復元します。

ワークスペースはパッケージのシンボリックリンクを処理するため、 yarn link手動で実行する必要はありません。また、リポジトリ間で共有されるパッケージの node_modules のホイストも処理されるため、インストール時間が短縮されます。すべてうまくいくといいですね™️。

追加情報については、個々のリポジトリの README ファイルも参照してください。

• ランナーのREADME
• デザイナーのREADME
• モデルの README
• e2e (スモークテスト) README

設定

スクリプトは常にルート ディレクトリから実行してください。

1. ノード 20 node --version使用していることを確認してください。
2. 糸 1.22 以降がインストールされていることを確認してください。 Yarn 2.4 以降をインストールする必要はありません。yarn は .yarn 内の Yarn 2 バイナリを検出し、それが使用されます。
3. デザイナーを使用する場合:
   • 設計中にフォームの投稿とプレビューを有効にするには、デザイナーはデフォルトのNODE_ENV=development設定 (runner/config/development.json を参照) でランナーを実行する必要があることに注意してください。
4. $ yarnコマンドを実行して、すべての依存関係をすべてのワークスペースにインストールします。
5. $ yarn build実行してすべてのワークスペースを構築します (依存関係が相互に依存する可能性があるため、これが必要です)。

すでに述べたように、スクリプトは常にルート ディレクトリから実行してください。ワークスペースには、フォルダー内から実行する必要があるスクリプトやパッケージがないため、ルート ディレクトリで実行することで、yarn 2 はスクリプトやパッケージを適切に解決できます。

ワークスペースの詳細については、次のリンクを確認してください。

• Yarn のワークスペース
• ワークスペース

したい...

特定のワークスペースのスクリプトを実行する

$ yarn [runner|designer|model] name-of-script

例: yarn designer startまたはyarn runner add babel-core --dev

各ワークスペースに対してスクリプトを実行する

$ yarn workspaces foreach run name-of-script

すべてのリポジトリにわたる変更を監視してビルドする

強力なプロセッサーを持っていない限り、お勧めしません。

$ yarn watch

すべてのワークスペースに依存関係を追加する

$ yarn add packagename

新しいワークスペースを作成する

1. ワークスペース用の新しいディレクトリを作成し、それを初期化します
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. ルートpackage.json内
   1. myNewLib workspacesオブジェクトに追加します。

トラブルシューティング

問題がある場合は、問題を送信するか、gitter 経由でメッセージを送信してください。

エラー: ENOENT: そのようなファイルまたはディレクトリはありません。scandir 'xxx/node_modules/node-sass/vendor'

/vendor構築または再構築されていないため、存在しません。 core-js 、 fsevents 、 nodemailerなどでもこの問題が発生する可能性があります。 $ yarn rebuildすべてのパッケージを再構築します$ yarn rebuild only node-sass sassだけを再構築します

CI

GitHub アクションを使用して CI プロセスを実行しています。ここでワークフローの視覚化をご覧ください。

バージョン管理

バージョン番号は、コミット メッセージと SemVer (Major.Minor.Patch) に基づいて自動的に増加します。マージするときは、マージ コミットの前に次の行を追加します。

• major:またはbreaking: - たとえば、 breaking: removing feature X 。これにより、メジャー バージョンが増加します - 例: 1.1.0 から 2.0.0
• minor:またはfeature: - たとえば、 feature: new component 。これにより、MINOR バージョンがインクリメントされます - 例: 1.1.0 から 1.2.0
• patch:またはfix: - 例: fix: url bug - これにより PATCH バージョンが増加します - 例: 1.0.0 から 1.0.1 (これはデフォルトでも発生します)

開発環境

開発ワークフローは、PR が main にマージされるたびにトリガーされ、リポジトリのアクション タブで監視できます。

ワークフローには、並行して実行される 2 つの個別のジョブ (ランナー アプリケーション用とデザイナー アプリケーション用) が含まれています。

どちらのジョブも次のように機能します。

1. すべての依存関係を含む Docker イメージをビルドします。
2. イメージを Heroku Container Registry にプッシュします。
3. 最新イメージを公開。

最新リリースはここで実行されます: ランナー / デザイナー。

煙テスト

すべての PR に対して一連のスモーク テストが実行されます。 Heroku デプロイメントに対してスモーク テストを実行する Cron ジョブがあり、毎日深夜に実行されるようにスケジュールされています。

レガシー スイートのスモーク テストは、このリポジトリにあります。これらは、プロジェクトがノード 18 で実行できるように削除されました。

スモーク テストは今後数か月以内に cypress.io を使用するように移行される予定です。