oss attribution builder

OSSアトリビューションビルダー

OSS Attribution Builderは、チームがソフトウェア製品の属性ドキュメントを作成するのを支援するWebサイトです。属性ドキュメントは、使用されるソフトウェアコンポーネントとそのライセンスをリストするほぼすべてのソフトウェアアプリケーションのテキストファイル、Webページ、または画面です。それらはしばしばアバートスクリーンに含まれており、「オープンソース通知」、「クレジット」、または他の同様の専門用語とラベル付けされることがあります。

スクリーンショット

クイックスタート

1. Dockerをインストールします
2. このリポジトリをクローンします
3. docker-compose up実行します
4. http：// localhost：8000/
   • デモはHTTP Basic Authを使用します。ユーザー名とパスワードを入力します。 adminを使用して、管理者機能をテストします。

ウェブサイトを使用します

ドキュメントを参照してください：

• ユーザー向け
• 管理者向け

警告

属性ビルダーはもともとAmazon-Internalツールでした。これを賢明なオープンソースプロジェクトにするために、いくつかの部分を削除する必要がありました。そのため、いくつかのいぼがあります：

• プロジェクトには連絡先リストがありますが、現時点ではUIは1つの連絡先のみをサポートしています（法的連絡先）。

これらはすべて時間内に修正されますが、しばらくの間奇妙なことがあるかもしれないことに注意してください。

カスタム展開

帰属ビルダーを独自の環境に統合する準備ができている場合は、セットアップするものがいくつかあります。

構成

config/default.jsを開き、突く。この構成はdocker-composeを実行するか、アプリケーションを起動すると起動します。

ライセンス

属性ビルダーは、2種類のライセンス定義をサポートしています。

• SPDX識別子
• 「既知の」ライセンステキストとタグ

SPDX識別子は、ライセンスセレクターの事前充填に使用されるだけですが、（現在）テキストはありません。より便利なタイプのライセンスは、「既知の」ライセンスであり、あなた（管理者）がライセンスのテキストと適用したいタグを提供します。

独自の「既知の」ライセンスを追加する詳細については、ライセンスREADMEを参照してください。同じディレクトリには、例を見ることができる2つの既存のライセンスがあります。

タグ

タグを使用すると、任意の検証ルールをライセンスに追加できます。それらは次のように役立ちます：

• ライセンスの確認が正しい方法で使用されています（例、LGPLおよびパッケージのリンク方法）
• あなたのビジネスに特別なプロセスがある場合、特定のライセンスにフォローアップが必要なものとして注釈を付ける
• 多くのバリエーションを使用したライセンスの帰属に関するガイダンスを提供します
• 属性ドキュメントにライセンスの表示方法を変更する

タグができることと独自の作成方法については、タグReadmeを参照してください。

拡張機能

属性ビルダーは、内部のパッチを当てる必要なく、クライアント側のサイトの動作と外観を変更できるようにする何らかの形の拡張機能を提供します。これにより、アップグレードが簡単になります。

詳細については、拡張機能を参照してください。

認証モジュール

アトリビューションビルダーは、プロジェクトACLを使用して特定の人またはグループへのアクセスを制限できることをサポートしています。これらは、投与およびパッケージの「検証」にも使用できます（詳細の詳細は後のセクションで）。デフォルトの実装nullauthは、ほとんどの環境ではあまり役に立ちません。より広く起動するとき、あなたはあなた自身を書きたいと思うでしょう。

実装の詳細については、ベースAUTHインターフェイスを参照してください。

ランニング

サーバーを起動するには、 npm run buildを使用してビルド後にbuild/server/localserver.jsを実行する必要があります。実行時に設定したい環境変数がいくつかあります。

• NODE_ENV 、おそらくproductionに設定する必要があります
• CONFIG_NAME 、上記で作成した構成ファイルのベースネーム（拡張子なし）に設定する必要があります。デフォルトは「デフォルト」です。

サーバーはHTTPでのみ実行されます。おそらく、その前に薄いHTTPS Webサーバーまたはプロキシを配置する必要があります。

貢献

情報については、貢献を参照してください。

発達

npm install 、その後、 npm run devローカル開発のために地面から離れます。これにより、PostgreSQL用のDockerコンテナが開始されますが、TSC、Webpack、ノードなどのローカルコピーを使用して、迅速に反復することができます。

物事が始まると、http：//0.0.0.0:2425/webpack-dev-server/を開くことができます。これにより、ブラウザの変更に自動的にリロードされ、バックエンドもサーバー側の変更で自動的に再起動します。

便利な環境変数：

• NODE_ENV ：設定またはdevelopmentの場合、フルソースマップとデバッグログを取得します
• DEBUG_SQL ：（何でも）設定すると、端末が実行されるときにSQLクエリが表示されます

テスト

npm testユニットテストを実行します。これらは主にサーバー焦点です。

npm run test-uiセレンテストを実行します。カスタムドライバーが必要な場合は、環境変数SELENIUM_DRIVER設定できます。デフォルトでは、Chromeを使用しようとします。利用できない場合はPhantomjsに戻ります。

UIテストをデバッグすると、 standalone-chrome docker-compose.selenium.ymlのstandalone-chrome-debugに変更し、VNC（ポート5900、パスワード「シークレット」）を介してコンテナに接続する方が簡単かもしれません。コンテナとテストを個別に実行します。

• docker-compose -f docker-compose.selenium.yml up --build
• tsc && jasmine --stop-on-failure=true 'build/selenium/*.spec.js'

一見理由で失敗したテスト？ driver.sleepが機能していませんか？テストのジャスミンのタイムアウトが十分に高いことを確認してください。