Move vendored assets to Git Submodules and `.gitignore` built assets
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- git, github, nodejs, shell
調査の方向性
まず update-blog.sh、update-readmes.sh、update-lb4-docs.js を読み、次に npm run build がそれらをどのように呼び出しているか、また CI が生成されたアセットをどのように扱っているかを調べます。サブモジュールの場所と、無視すべきビルドパスを定義します。ベンダー化されたソースの Git 上の出自が明確になり、ビルドによって追跡対象の生成コピーが上書きされなくなり、既存のサイトビルドが引き続き動作すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The website has scripts which pulls data from GitHub and NPM:
update-blog.sh
Clonesloopbackio/loopback-bloginto/blogupdate-readmes.sh
Downloads READMEs from GitHub "raw" or NPM Registry into/doc/en/[lb3|lb4|community]/readmesupdate-lb4-docs.js
Copies pre-generated markdown API Docs from@loopback/docsinto/doc/en/lb4
They pose some issues:
- Accidental manual editing: Contributors may accidentally contribute changes to these assets, only to be overridden by the CI pipeline.
- Rate-limitng: Contributors running
npm run build->update-readmes.shmay inadvertently update the local copies with GitHub "rate limit reached" error pages. - Unclear provenance: As the
.gitdirectory is not preserved, the provenance of where and when exactly the assets were vendored is no clear. - Updates are reactive: The assets are only re-vendored when a PR is merged.
Git Submodules solve this problem. Updates would be handled by Renovate instead, which would open PRs.
- 主要言語
- HTML
- スター
- 276
- フォーク
- 382
- 平均マージ
- 6時間 19分
- マージ済み PR（30日）
- 25
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
loopbackio/loopback.io のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
loopbackio/loopback.io#1783 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
loopbackio/loopback.io#1781 ·
メンテナーはふだん 1 日以内に返信
-
Documentation is very unfriendly 😞再び着手できるかも @Geof-Sumari が 240 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンcommunity-contribution
loopbackio/loopback.io#1772 · コメント 2 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
help wanted
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
loopbackio/loopback.io#1751 · コメント 1 件 · リアクション 3 件 ·
メンテナーはふだん 1 日以内に返信
-
help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
loopbackio/loopback.io#1580 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
loopbackio/loopback.io の issue をすべて見る
似ている issue
-
needs-triage Platform(Default)
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
atlassian-labs/compiled#1960 ·
メンテナーはふだん 1 日以内に返信
-
Cached wheel reuse fails when the build and metadata fallback share an output directory対応中かも @harbinresearcher が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
pypa/pyproject-hooks#240 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 6 日以内に返信