Build: Migrate to uv

.github/workflows/deploy.yml

@@ -15,15 +15,14 @@ jobs:
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: ~/.cache 
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install -r requirements.txt 
-      - run: mkdocs gh-deploy --force
+          version: "0.10.7"
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install
+      - name: Install the project
+        run: uv sync --locked
+      - name: Deploy the pages
+        run: uv run mkdocs gh-deploy --force

.github/workflows/test.yml

@@ -15,15 +15,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: ~/.cache 
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install -r requirements.txt 
-      - run: mkdocs build --strict
+          version: "0.10.7"
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install
+      - name: Install the project
+        run: uv sync --locked
+      - name: Build the pages
+        run: uv run mkdocs build --strict

.python-version

@@ -0,0 +1 @@
+3.9

CONTRIBUTING.md

@@ -26,5 +26,5 @@
 
 1. `docs/` の中にMarkdownファイルを作成
 2. `mkdocs.yml` の `nav` に追記
-3. `mkdocs serve` を実行して、ローカルで確認
+3. `uv run mkdocs serve` を実行して、ローカルで確認
 

README.md

@@ -2,15 +2,33 @@
 
 主にMinecraft Forge 1.20.1のModdingについて解説したサイトです。
 
+## セットアップ
+
+パッケージ管理のため、[uvのインストール](https://docs.astral.sh/uv/getting-started/installation/)が必要です。
+
+macOS/Linux:
+```shell
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Windows:
+```shell
+PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+依存関係をインストールするには:
+```shell
+$ uv sync
+```
+
 ## ビルド
 
 HTMLにビルドする場合以下のコマンドを実行してください。
 ```shell
-$ pip install -r requirements.txt
-$ mkdocs build
+$ uv run mkdocs build
 ```
 
 開発中のドキュメントを見る場合、以下のコマンドを実行します。
 ```shell
-$ mkdocs serve
+$ uv run mkdocs serve
 ```

pyproject.toml

@@ -0,0 +1,13 @@
+[project]
+name = "modding-notes"
+version = "0.1.0"
+description = "Minecraft Modding Explained"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.3",
+    "mkdocs-redirects>=1.2.2",
+    "mkdocs-simple-hooks>=0.1.5",
+    "pymdown-extensions>=10.21",
+]