GitHub Actions

GitHub Actionsを利用すると、GitHub Releaseの作成後にModParksへVersionを自動登録できます。

APIキーを作成する

ModParks APIを利用するにはAPIキーが必要です。

ModParksへログインします。アカウント設定からAPIキーを作成します。発行したAPIキーをコピーします。

GitHub Secretsを設定する

GitHubリポジトリの Settings → Secrets and variables → Actions を開きます。

New repository secret をクリックし、次の内容でSecretを作成します。

Name	Value
`MODPARKSAPIKEY`	ModParksで発行したAPIキー

GitHub Actionsを設定する

Releaseを作成するGitHub Actionsワークフローに、ModParksへの登録処理を追加します。

以下はGitHub Releaseを作成し、その後ModParksへ登録するワークフローの例です。

name: Release

on:
  push:
    tags:
      - "v*"

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"

設定を変更する

ワークフロー内の以下の値は、自分のプロジェクトに合わせて変更してください。

項目	説明
`PROJECT_SLUG`	ModParksのプロジェクトスラッグ
`mcVersions`	対応するMinecraftバージョン（複数指定可能）
`loaders`	対応するModローダー（複数指定可能）

バージョンを公開する

ワークフローをコミットした後、タグを作成してGitHubへプッシュします。

git tag v1.0.0
git push origin v1.0.0

タグのプッシュ後にGitHub Actionsが実行され、正常に完了するとGitHub Releaseの作成とModParksへのVersion登録が自動で行われます。

注意事項

APIキーはワークフローへ直接記述せず、GitHub Secretsを利用してください。 fileUrl はModParksサーバーからアクセスできる公開URLである必要があります。同じバージョン番号が登録済みの場合は、新しいVersionとして登録できません。

ModParks Wiki

目次