差分

このページの2つのバージョン間の差分を表示します。

--- gh-actions [2026/08/02 22:52] – admin
+++ gh-actions [2026/08/02 23:01] (現在) – [GitHub Actionsを設定する] admin
@@ 行 1: / 行 1: @@
-====== GitHub Actions 連携 ======
+====== GitHub Actions ======
-ModParksでは、GitHub ActionsからAPIを利用して、新しいVersionを自動的に登録できます。
+GitHub Actionsを利用すると、GitHub Releaseの作成後にModParksへVersionを自動登録できます。
-GitHub Releaseの公開に合わせてワークフローを実行することで、手動でVersionを追加する手間を省くことができます。
+===== APIキーを作成する =====
-===== 機能概要 =====
+ModParks APIを利用するにはAPIキーが必要です。
-GitHub ActionsからModParks APIを呼び出すことで、プロジェクトへVersionを登録できます。
+ModParksへログインします。
+アカウント設定からAPIキーを作成します。
+発行したAPIキーをコピーします。
-* GitHub Releaseの公開後に自動でVersionを登録できます。
+===== GitHub Secretsを設定する =====
-* ダウンロードURLを指定することで、ModParksがファイルを取得します。
-* Minecraftバージョンやローダー、変更履歴も同時に登録できます。
-===== 事前準備 =====
+GitHubリポジトリの ''Settings'' → ''Secrets and variables'' → ''Actions'' を開きます。
-利用するには、以下の準備が必要です。
+''New repository secret'' をクリックし、次の内容でSecretを作成します。
-* ModParksでプロジェクトを作成していること
+^Name^Value^
-* APIキーを発行していること
+|''MODPARKS_API_KEY''|ModParksで発行したAPIキー|
-* GitHubリポジトリの ''Settings'' → ''Secrets and variables'' → ''Actions'' に ''MODPARKS_API_KEY'' としてAPIキーを登録していること
-===== GitHub Actions の設定 =====
+===== GitHub Actionsを設定する =====
-以下は、GitHub Releaseの作成後にVersionを登録するワークフローの例です。
+Releaseを作成するGitHub Actionsワークフローに、ModParksへの登録処理を追加します。
+以下はGitHub Releaseを作成し、その後ModParksへ登録するワークフローの例です。
 <code yaml>
-- name: Register to ModParks
+name: Release
-  env:
-    MODPARKS_URL: https://modparks.pitan76.net
-    PROJECT_SLUG: your-project
-    VERSION_NUMBER: ${{ github.ref_name }}
-  run: |
-    FILE_NAME=$(basename build/libs/*.jar)
-    FILE_URL="https://github.com/${{ github.repository }}/releases/download/${VERSION_NUMBER}/${FILE_NAME}"
-```
+on:
-curl -X POST "$MODPARKS_URL/api/v1/projects/$PROJECT_SLUG/versions" \
+  push:
-  -H "Authorization: Bearer ${{ secrets.MODPARKS_API_KEY }}" \
+    tags:
-  -F "versionNumber=$VERSION_NUMBER" \
+      - "v*"
-  -F "mcVersions=your-minecraft-version" \
-  -F "loaders=fabric" \
-  -F "changelog=${{ github.event.head_commit.message }}" \
-  -F "fileUrl=$FILE_URL"
-```
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: gradle
+      - uses: gradle/actions/setup-gradle@v4
+      - name: Grant execute permission
+        run: chmod +x gradlew
+      - name: Build
+        run: ./gradlew build
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            build/libs/*.jar
+          body: |
+            ${{ github.event.head_commit.message }}
+          generate_release_notes: true
+      - name: Register to ModParks
+        env:
+          MODPARKS_URL: https://modparks.pitan76.net
+          PROJECT_SLUG: your-project-slug
+          VERSION_NUMBER: ${{ github.ref_name }}
+        run: |
+          FILE_NAME=$(basename build/libs/*.jar)
+          FILE_URL="https://github.com/${{ github.repository }}/releases/download/${VERSION_NUMBER}/${FILE_NAME}"
+          curl -X POST "$MODPARKS_URL/api/v1/projects/$PROJECT_SLUG/versions" \
+            -H "Authorization: Bearer ${{ secrets.MODPARKS_API_KEY }}" \
+            -F "versionNumber=$VERSION_NUMBER" \
+            -F "mcVersions=1.21.8" \
+            -F "loaders=fabric" \
+            -F "changelog=${{ github.event.head_commit.message }}" \
+            -F "fileUrl=$FILE_URL"
 </code>
-''mcVersions'' および ''loaders'' は複数指定できます。
+===== 設定を変更する =====
-===== 注意事項 =====
+ワークフロー内の以下の値は、自分のプロジェクトに合わせて変更してください。
-* ''fileUrl'' はModParksサーバーからアクセス可能な公開URLである必要があります。
+^項目^説明^
-* APIキーはGitHub Secretsを利用し、ワークフロー内へ直接記述しないでください。
+|''PROJECT_SLUG''|ModParksのプロジェクトスラッグ|
-* 同じバージョン番号が既に登録されている場合は、新しく登録できません。
+|''mcVersions''|対応するMinecraftバージョン（複数指定可能）|
-* 詳細なAPI仕様についてはAPIリファレンスを参照してください。
+|''loaders''|対応するModローダー（複数指定可能）|
+===== バージョンを公開する =====
+ワークフローをコミットした後、タグを作成してGitHubへプッシュします。
+<code bash>
+git tag v1.0.0
+git push origin v1.0.0
+</code>
+タグのプッシュ後にGitHub Actionsが実行され、正常に完了するとGitHub Releaseの作成とModParksへのVersion登録が自動で行われます。
+===== 注意事項 =====
+APIキーはワークフローへ直接記述せず、GitHub Secretsを利用してください。
+''fileUrl'' はModParksサーバーからアクセスできる公開URLである必要があります。
+同じバージョン番号が登録済みの場合は、新しいVersionとして登録できません。