👨🏫
Monorepo で README のシンボリックリンクを設定する
はじめに
複数パッケージを管理している Monorepo では、主となるパッケージの README を初期表示のページに表示したい場合があります。
README の中身を丸々コピーするのは保守性的によくないため、シンボリックリンクを設定して対応します。
前提条件
- macOS
- Monterey
- バージョン 12.4
- チップ Apple M1 Ultra
例
1. リポジトリを作成してクローン
# https://cli.github.com/manual/gh_repo_create
gh repo create sample_symlink --public --clone
cd sample_symlink
※ コマンドを使わず、ブラウザの GitHub のページからリポジトリを作成しても問題ありません。
2. リンク先の README を作成
mkdir -p packages/hoge
cat <<EOF > packages/hoge/README.md
# Sample
EOF
3. シンボリックリンクを設定してプッシュ
ln -s packages/hoge/README.md README.md
git add .
git commit -m "initial commit"
git branch -M main
git push -u origin main
無事にシンボリックリンクを設定できました🎉
おわりに
ln コマンドの使い方はすぐ忘れてしまいそうなので、備忘録として残しました。
Discussion